From a02dfeabd9f880062ff3ad01da94ea9cb9a6836f Mon Sep 17 00:00:00 2001 From: BDisp Date: Thu, 21 Jul 2022 23:16:40 +0100 Subject: [PATCH] Fixes #1874. API docs on github are broken. (#1875) * Fixes #1874. API docs on github are broken. * Rebuild with docfx 2.59.3.0 version. --- Terminal.Gui/Core/ContextMenu.cs | 4 +- docs/README.html | 2 +- ...inal.Gui.Application.ResizedEventArgs.html | 213 + .../Terminal.Gui.Application.RunState.html | 266 + .../Terminal.Gui.Application.html | 1221 + .../Terminal.Gui/Terminal.Gui.Attribute.html | 519 + .../Terminal.Gui.Autocomplete.html | 967 + ...Terminal.Gui.Border.ToplevelContainer.html | 891 + .../api/Terminal.Gui/Terminal.Gui.Border.html | 648 + .../Terminal.Gui.BorderStyle.html | 164 + .../api/Terminal.Gui/Terminal.Gui.Button.html | 1063 + .../Terminal.Gui/Terminal.Gui.CheckBox.html | 983 + .../Terminal.Gui/Terminal.Gui.Clipboard.html | 295 + .../Terminal.Gui.ClipboardBase.html | 412 + docs/api/Terminal.Gui/Terminal.Gui.Color.html | 236 + .../Terminal.Gui.ColorPicker.html | 982 + .../Terminal.Gui.ColorScheme.html | 499 + .../api/Terminal.Gui/Terminal.Gui.Colors.html | 339 + .../Terminal.Gui/Terminal.Gui.ComboBox.html | 1176 + .../Terminal.Gui/Terminal.Gui.Command.html | 593 + ...nal.Gui.ConsoleDriver.DiagnosticFlags.html | 161 + .../Terminal.Gui.ConsoleDriver.html | 2249 ++ .../Terminal.Gui.ContextMenu.html | 558 + .../Terminal.Gui.CursorVisibility.html | 188 + .../Terminal.Gui/Terminal.Gui.DateField.html | 1007 + .../Terminal.Gui.DateTimeEventArgs-1.html | 292 + .../Terminal.Gui.Dialog.ButtonAlignments.html | 164 + .../api/Terminal.Gui/Terminal.Gui.Dialog.html | 925 + docs/api/Terminal.Gui/Terminal.Gui.Dim.html | 639 + .../Terminal.Gui.DisplayModeLayout.html | 152 + .../Terminal.Gui.FakeConsole.html | 2730 ++ .../Terminal.Gui/Terminal.Gui.FakeDriver.html | 1221 + .../Terminal.Gui.FakeMainLoop.html | 313 + .../Terminal.Gui/Terminal.Gui.FileDialog.html | 1159 + .../Terminal.Gui/Terminal.Gui.FrameView.html | 916 + .../Terminal.Gui/Terminal.Gui.GraphView.html | 1147 + .../Terminal.Gui.Graphs.Axis.html | 510 + ...inal.Gui.Graphs.AxisIncrementToRender.html | 276 + .../Terminal.Gui.Graphs.BarSeries.Bar.html | 276 + .../Terminal.Gui.Graphs.BarSeries.html | 446 + ...Terminal.Gui.Graphs.GraphCellToRender.html | 303 + .../Terminal.Gui.Graphs.HorizontalAxis.html | 378 + .../Terminal.Gui.Graphs.IAnnotation.html | 196 + .../Terminal.Gui.Graphs.ISeries.html | 168 + ...rminal.Gui.Graphs.LabelGetterDelegate.html | 160 + .../Terminal.Gui.Graphs.LegendAnnotation.html | 338 + .../Terminal.Gui.Graphs.MultiBarSeries.html | 340 + .../Terminal.Gui.Graphs.Orientation.html | 152 + ...minal.Gui.Graphs.PathAnnotation.LineF.html | 243 + .../Terminal.Gui.Graphs.PathAnnotation.html | 297 + .../Terminal.Gui.Graphs.ScatterSeries.html | 258 + .../Terminal.Gui.Graphs.TextAnnotation.html | 338 + .../Terminal.Gui.Graphs.VerticalAxis.html | 379 + .../api/Terminal.Gui/Terminal.Gui.Graphs.html | 207 + ...Terminal.Gui.HexView.HexViewEventArgs.html | 277 + .../Terminal.Gui/Terminal.Gui.HexView.html | 1155 + .../Terminal.Gui.IAutocomplete.html | 577 + .../Terminal.Gui/Terminal.Gui.IClipboard.html | 323 + .../Terminal.Gui.IListDataSource.html | 347 + .../Terminal.Gui.IMainLoopDriver.html | 219 + .../Terminal.Gui/Terminal.Gui.ITreeView.html | 179 + docs/api/Terminal.Gui/Terminal.Gui.Key.html | 751 + .../Terminal.Gui/Terminal.Gui.KeyEvent.html | 432 + .../Terminal.Gui.KeyModifiers.html | 303 + docs/api/Terminal.Gui/Terminal.Gui.Label.html | 941 + .../Terminal.Gui.LayoutStyle.html | 155 + .../Terminal.Gui/Terminal.Gui.LineView.html | 764 + .../Terminal.Gui/Terminal.Gui.ListView.html | 1726 + .../Terminal.Gui.ListViewItemEventArgs.html | 247 + .../Terminal.Gui.ListViewRowEventArgs.html | 243 + .../Terminal.Gui.ListWrapper.html | 411 + .../Terminal.Gui.MainLoop.Timeout.html | 207 + .../Terminal.Gui/Terminal.Gui.MainLoop.html | 607 + .../Terminal.Gui/Terminal.Gui.MenuBar.html | 1423 + .../Terminal.Gui.MenuBarItem.html | 515 + .../Terminal.Gui.MenuClosingEventArgs.html | 302 + .../Terminal.Gui/Terminal.Gui.MenuItem.html | 598 + .../Terminal.Gui.MenuItemCheckStyle.html | 159 + .../Terminal.Gui.MenuOpeningEventArgs.html | 267 + .../Terminal.Gui/Terminal.Gui.MessageBox.html | 993 + .../Terminal.Gui/Terminal.Gui.MouseEvent.html | 321 + .../Terminal.Gui/Terminal.Gui.MouseFlags.html | 319 + .../Terminal.Gui.OpenDialog.OpenMode.html | 158 + .../Terminal.Gui/Terminal.Gui.OpenDialog.html | 924 + .../Terminal.Gui/Terminal.Gui.PanelView.html | 788 + docs/api/Terminal.Gui/Terminal.Gui.Point.html | 846 + .../api/Terminal.Gui/Terminal.Gui.PointF.html | 908 + docs/api/Terminal.Gui/Terminal.Gui.Pos.html | 855 + .../Terminal.Gui.ProgressBar.html | 873 + .../Terminal.Gui.ProgressBarFormat.html | 170 + .../Terminal.Gui.ProgressBarStyle.html | 164 + .../Terminal.Gui/Terminal.Gui.RadioGroup.html | 1075 + docs/api/Terminal.Gui/Terminal.Gui.Rect.html | 1361 + .../Terminal.Gui/Terminal.Gui.RectangleF.html | 1351 + .../Terminal.Gui/Terminal.Gui.Responder.html | 824 + .../Terminal.Gui/Terminal.Gui.SaveDialog.html | 839 + .../Terminal.Gui.ScrollBarView.html | 1113 + .../Terminal.Gui/Terminal.Gui.ScrollView.html | 1174 + .../Terminal.Gui.SelectedItemChangedArgs.html | 247 + .../Terminal.Gui.ShortcutHelper.html | 602 + docs/api/Terminal.Gui/Terminal.Gui.Size.html | 787 + docs/api/Terminal.Gui/Terminal.Gui.SizeF.html | 952 + .../Terminal.Gui.StackExtensions.html | 543 + .../Terminal.Gui/Terminal.Gui.StatusBar.html | 928 + .../Terminal.Gui/Terminal.Gui.StatusItem.html | 285 + .../Terminal.Gui.TabView.Tab.html | 253 + ...minal.Gui.TabView.TabChangedEventArgs.html | 247 + .../Terminal.Gui.TabView.TabStyle.html | 239 + .../Terminal.Gui/Terminal.Gui.TabView.html | 1033 + ....Gui.TableView.CellActivatedEventArgs.html | 277 + ...nal.Gui.TableView.CellColorGetterArgs.html | 310 + ...Gui.TableView.CellColorGetterDelegate.html | 160 + .../Terminal.Gui.TableView.ColumnStyle.html | 457 + ...inal.Gui.TableView.RowColorGetterArgs.html | 210 + ....Gui.TableView.RowColorGetterDelegate.html | 160 + ...ableView.SelectedCellChangedEventArgs.html | 337 + ...Terminal.Gui.TableView.TableSelection.html | 243 + .../Terminal.Gui.TableView.TableStyle.html | 542 + .../Terminal.Gui/Terminal.Gui.TableView.html | 1730 + .../Terminal.Gui.TextAlignment.html | 164 + .../Terminal.Gui.TextChangingEventArgs.html | 242 + .../Terminal.Gui.TextDirection.html | 196 + .../Terminal.Gui/Terminal.Gui.TextField.html | 1563 + .../Terminal.Gui.TextFieldAutocomplete.html | 316 + .../Terminal.Gui.TextFormatter.html | 1837 + .../Terminal.Gui.TextValidateField.html | 816 + ...lidateProviders.ITextValidateProvider.html | 499 + ...lidateProviders.NetMaskedTextProvider.html | 569 + ...xtValidateProviders.TextRegexProvider.html | 591 + .../Terminal.Gui.TextValidateProviders.html | 140 + .../Terminal.Gui/Terminal.Gui.TextView.html | 2265 ++ .../Terminal.Gui.TextViewAutocomplete.html | 316 + .../Terminal.Gui/Terminal.Gui.Thickness.html | 346 + .../Terminal.Gui/Terminal.Gui.TimeField.html | 1007 + .../Terminal.Gui/Terminal.Gui.Toplevel.html | 1791 + ...Terminal.Gui.ToplevelClosingEventArgs.html | 242 + .../Terminal.Gui.ToplevelComparer.html | 215 + ...Terminal.Gui.ToplevelEqualityComparer.html | 268 + .../Terminal.Gui/Terminal.Gui.TreeView-1.html | 2400 ++ .../Terminal.Gui/Terminal.Gui.TreeView.html | 793 + ...inal.Gui.Trees.AspectGetterDelegate-1.html | 177 + ...minal.Gui.Trees.DelegateTreeBuilder-1.html | 338 + .../Terminal.Gui.Trees.ITreeBuilder-1.html | 265 + .../Terminal.Gui.Trees.ITreeNode.html | 207 + ....Gui.Trees.ObjectActivatedEventArgs-1.html | 260 + ...Gui.Trees.SelectionChangedEventArgs-1.html | 293 + .../Terminal.Gui.Trees.TreeBuilder-1.html | 323 + .../Terminal.Gui.Trees.TreeNode.html | 307 + .../Terminal.Gui.Trees.TreeNodeBuilder.html | 231 + .../Terminal.Gui.Trees.TreeStyle.html | 314 + docs/api/Terminal.Gui/Terminal.Gui.Trees.html | 169 + .../Terminal.Gui.VerticalTextAlignment.html | 164 + .../Terminal.Gui.View.FocusEventArgs.html | 243 + .../Terminal.Gui.View.KeyEventEventArgs.html | 243 + .../Terminal.Gui.View.LayoutEventArgs.html | 188 + .../Terminal.Gui.View.MouseEventArgs.html | 243 + docs/api/Terminal.Gui/Terminal.Gui.View.html | 4303 +++ .../Terminal.Gui.Window.TitleEventArgs.html | 272 + .../api/Terminal.Gui/Terminal.Gui.Window.html | 1188 + ...rminal.Gui.Wizard.StepChangeEventArgs.html | 272 + ...inal.Gui.Wizard.WizardButtonEventArgs.html | 200 + ....Gui.Wizard.WizardStep.TitleEventArgs.html | 272 + .../Terminal.Gui.Wizard.WizardStep.html | 952 + .../api/Terminal.Gui/Terminal.Gui.Wizard.html | 1414 + docs/api/Terminal.Gui/Terminal.Gui.html | 710 + .../Unix.Terminal.Curses.Event.html | 247 + .../Unix.Terminal.Curses.MouseEvent.html | 259 + .../Unix.Terminal.Curses.Window.html | 861 + .../Terminal.Gui/Unix.Terminal.Curses.html | 5642 +++ docs/api/Terminal.Gui/Unix.Terminal.html | 134 + docs/api/Terminal.Gui/toc.html | 543 + .../UICatalog/UICatalog.NumberToWords.html | 237 + .../UICatalog.Scenario.ScenarioCategory.html | 402 + .../UICatalog.Scenario.ScenarioMetadata.html | 429 + docs/api/UICatalog/UICatalog.Scenario.html | 547 + .../UICatalog.Scenarios.AllViewsTester.html | 249 + ...og.Scenarios.AutoSizeAndDirectionText.html | 211 + ....Scenarios.BackgroundWorkerCollection.html | 243 + .../UICatalog.Scenarios.BasicColors.html | 212 + .../UICatalog.Scenarios.Borders.html | 212 + ...ICatalog.Scenarios.BordersComparisons.html | 241 + ...ICatalog.Scenarios.BordersOnFrameView.html | 212 + ...UICatalog.Scenarios.BordersOnToplevel.html | 212 + .../UICatalog.Scenarios.BordersOnWindow.html | 212 + .../UICatalog.Scenarios.Buttons.html | 212 + .../UICatalog.Scenarios.CharacterMap.html | 226 + .../UICatalog.Scenarios.ClassExplorer.html | 212 + .../UICatalog.Scenarios.Clipping.html | 240 + .../UICatalog.Scenarios.ColorPickers.html | 213 + ...UICatalog.Scenarios.ComboBoxIteration.html | 212 + .../UICatalog.Scenarios.ComputedLayout.html | 222 + .../UICatalog.Scenarios.ContextMenus.html | 211 + .../UICatalog.Scenarios.CsvEditor.html | 217 + .../UICatalog.Scenarios.Dialogs.html | 211 + ...alog.Scenarios.DynamicMenuBar.Binding.html | 296 + ....DynamicMenuBar.DynamicMenuBarDetails.html | 949 + ...s.DynamicMenuBar.DynamicMenuBarSample.html | 761 + ...narios.DynamicMenuBar.DynamicMenuItem.html | 406 + ...os.DynamicMenuBar.DynamicMenuItemList.html | 267 + ...s.DynamicMenuBar.DynamicMenuItemModel.html | 310 + ...narios.DynamicMenuBar.IValueConverter.html | 173 + ...s.DynamicMenuBar.ListWrapperConverter.html | 210 + ....DynamicMenuBar.UStringValueConverter.html | 210 + .../UICatalog.Scenarios.DynamicMenuBar.html | 234 + ...og.Scenarios.DynamicStatusBar.Binding.html | 296 + ...amicStatusBar.DynamicStatusBarDetails.html | 826 + ...namicStatusBar.DynamicStatusBarSample.html | 808 + ...os.DynamicStatusBar.DynamicStatusItem.html | 293 + ...ynamicStatusBar.DynamicStatusItemList.html | 267 + ...namicStatusBar.DynamicStatusItemModel.html | 287 + ...rios.DynamicStatusBar.IValueConverter.html | 173 + ...DynamicStatusBar.ListWrapperConverter.html | 210 + ...ynamicStatusBar.UStringValueConverter.html | 210 + .../UICatalog.Scenarios.DynamicStatusBar.html | 233 + .../UICatalog/UICatalog.Scenarios.Editor.html | 245 + .../UICatalog.Scenarios.GraphViewExample.html | 211 + .../UICatalog.Scenarios.HexEditor.html | 215 + .../UICatalog.Scenarios.InteractiveTree.html | 212 + .../UICatalog.Scenarios.InvertColors.html | 212 + .../UICatalog/UICatalog.Scenarios.Keys.html | 240 + .../UICatalog.Scenarios.LabelsAsLabels.html | 212 + .../UICatalog.Scenarios.LineViewExample.html | 212 + ...talog.Scenarios.ListViewWithSelection.html | 324 + .../UICatalog.Scenarios.ListsAndCombos.html | 213 + .../UICatalog.Scenarios.MessageBoxes.html | 212 + .../UICatalog/UICatalog.Scenarios.Mouse.html | 211 + ...ICatalog.Scenarios.MultiColouredTable.html | 213 + .../UICatalog.Scenarios.MyScenario.html | 211 + .../UICatalog.Scenarios.Notepad.html | 243 + .../UICatalog.Scenarios.Progress.html | 237 + ...UICatalog.Scenarios.ProgressBarStyles.html | 213 + ...log.Scenarios.RuneWidthGreaterThanOne.html | 240 + .../UICatalog.Scenarios.Scrolling.html | 212 + .../UICatalog.Scenarios.SendKeys.html | 211 + ...narios.SingleBackgroundWorker.MainApp.html | 703 + ...eBackgroundWorker.StagingUIController.html | 751 + ...alog.Scenarios.SingleBackgroundWorker.html | 212 + ...ICatalog.Scenarios.SyntaxHighlighting.html | 213 + .../UICatalog.Scenarios.TabViewExample.html | 212 + .../UICatalog.Scenarios.TableEditor.html | 307 + .../UICatalog/UICatalog.Scenarios.Text.html | 213 + .../UICatalog.Scenarios.TextAlignments.html | 211 + ...Scenarios.TextAlignmentsAndDirections.html | 211 + ...UICatalog.Scenarios.TextFormatterDemo.html | 211 + ...g.Scenarios.TextViewAutocompletePopup.html | 213 + .../UICatalog.Scenarios.Threading.html | 211 + .../UICatalog.Scenarios.TimeAndDate.html | 212 + .../UICatalog.Scenarios.TreeUseCases.html | 212 + ...ICatalog.Scenarios.TreeViewFileSystem.html | 213 + .../UICatalog.Scenarios.UnicodeInMenu.html | 212 + ...atalog.Scenarios.WindowsAndFrameViews.html | 254 + .../UICatalog.Scenarios.WizardAsView.html | 240 + .../UICatalog.Scenarios.Wizards.html | 213 + docs/api/UICatalog/UICatalog.Scenarios.html | 290 + .../api/UICatalog/UICatalog.UICatalogApp.html | 156 + docs/api/UICatalog/UICatalog.html | 144 + docs/api/UICatalog/toc.html | 282 + docs/articles/index.html | 2 +- docs/articles/keyboard.html | 2 +- docs/articles/mainloop.html | 6 +- docs/articles/overview.html | 32 +- docs/articles/tableview.html | 4 +- docs/articles/treeview.html | 4 +- docs/articles/views.html | 2 +- docs/index.html | 6 +- docs/index.json | 1265 + docs/manifest.json | 3103 +- docs/toc.html | 2 +- docs/xrefmap.yml | 29911 +++++++++++++++- 269 files changed, 165184 insertions(+), 59 deletions(-) create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Application.ResizedEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Application.RunState.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Application.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Attribute.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Autocomplete.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Border.ToplevelContainer.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Border.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.BorderStyle.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Button.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.CheckBox.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Clipboard.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ClipboardBase.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Color.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ColorPicker.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ColorScheme.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Colors.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ComboBox.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Command.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ConsoleDriver.DiagnosticFlags.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ConsoleDriver.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ContextMenu.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.CursorVisibility.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.DateField.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.DateTimeEventArgs-1.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Dialog.ButtonAlignments.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Dialog.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Dim.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.DisplayModeLayout.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.FakeConsole.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.FakeDriver.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.FakeMainLoop.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.FileDialog.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.FrameView.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.GraphView.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.Axis.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.AxisIncrementToRender.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.Bar.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.GraphCellToRender.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.HorizontalAxis.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.IAnnotation.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.ISeries.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.LabelGetterDelegate.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.LegendAnnotation.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.MultiBarSeries.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.Orientation.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.LineF.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.ScatterSeries.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.TextAnnotation.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.VerticalAxis.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Graphs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.HexView.HexViewEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.HexView.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.IAutocomplete.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.IClipboard.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.IListDataSource.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.IMainLoopDriver.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ITreeView.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Key.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.KeyEvent.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.KeyModifiers.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Label.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.LayoutStyle.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.LineView.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ListView.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ListViewItemEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ListViewRowEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ListWrapper.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.MainLoop.Timeout.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.MainLoop.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.MenuBarItem.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.MenuClosingEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.MenuItem.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.MenuItemCheckStyle.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.MenuOpeningEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.MessageBox.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.MouseEvent.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.MouseFlags.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.OpenDialog.OpenMode.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.OpenDialog.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.PanelView.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Point.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.PointF.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Pos.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ProgressBar.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ProgressBarFormat.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ProgressBarStyle.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.RadioGroup.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Rect.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.RectangleF.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Responder.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.SaveDialog.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.SelectedItemChangedArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Size.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.SizeF.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.StackExtensions.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.StatusItem.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TabView.Tab.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TabView.TabChangedEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TabView.TabStyle.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TabView.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TableView.CellActivatedEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterDelegate.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TableView.ColumnStyle.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterDelegate.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TableView.SelectedCellChangedEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TableView.TableSelection.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TableView.TableStyle.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TableView.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TextAlignment.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TextDirection.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TextField.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TextFieldAutocomplete.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TextFormatter.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TextValidateField.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.ITextValidateProvider.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.NetMaskedTextProvider.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.TextRegexProvider.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TextView.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TextViewAutocomplete.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Thickness.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TimeField.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Toplevel.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ToplevelClosingEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ToplevelComparer.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.ToplevelEqualityComparer.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TreeView-1.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.TreeView.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Trees.AspectGetterDelegate-1.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Trees.DelegateTreeBuilder-1.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Trees.ITreeBuilder-1.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Trees.ITreeNode.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Trees.ObjectActivatedEventArgs-1.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Trees.SelectionChangedEventArgs-1.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeBuilder-1.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeNode.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeNodeBuilder.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeStyle.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Trees.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.VerticalTextAlignment.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.View.FocusEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.View.KeyEventEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.View.LayoutEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.View.MouseEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.View.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Window.TitleEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Window.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Wizard.StepChangeEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Wizard.WizardButtonEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Wizard.WizardStep.TitleEventArgs.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Wizard.WizardStep.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.Wizard.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.html create mode 100644 docs/api/Terminal.Gui/Unix.Terminal.Curses.Event.html create mode 100644 docs/api/Terminal.Gui/Unix.Terminal.Curses.MouseEvent.html create mode 100644 docs/api/Terminal.Gui/Unix.Terminal.Curses.Window.html create mode 100644 docs/api/Terminal.Gui/Unix.Terminal.Curses.html create mode 100644 docs/api/Terminal.Gui/Unix.Terminal.html create mode 100644 docs/api/Terminal.Gui/toc.html create mode 100644 docs/api/UICatalog/UICatalog.NumberToWords.html create mode 100644 docs/api/UICatalog/UICatalog.Scenario.ScenarioCategory.html create mode 100644 docs/api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html create mode 100644 docs/api/UICatalog/UICatalog.Scenario.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.AllViewsTester.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.AutoSizeAndDirectionText.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.BackgroundWorkerCollection.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.BasicColors.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.Borders.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.BordersComparisons.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.BordersOnFrameView.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.BordersOnToplevel.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.BordersOnWindow.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.Buttons.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.CharacterMap.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.ClassExplorer.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.Clipping.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.ColorPickers.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.ComboBoxIteration.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.ComputedLayout.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.ContextMenus.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.CsvEditor.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.Dialogs.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.Binding.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuBarDetails.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuBarSample.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItem.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItemList.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItemModel.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.IValueConverter.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.ListWrapperConverter.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.UStringValueConverter.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.Binding.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusBarDetails.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusBarSample.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItem.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItemList.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItemModel.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.IValueConverter.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.ListWrapperConverter.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.UStringValueConverter.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.Editor.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.GraphViewExample.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.HexEditor.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.InteractiveTree.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.InvertColors.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.Keys.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.LabelsAsLabels.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.LineViewExample.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.ListViewWithSelection.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.ListsAndCombos.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.MessageBoxes.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.Mouse.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.MultiColouredTable.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.MyScenario.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.Notepad.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.Progress.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.ProgressBarStyles.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.RuneWidthGreaterThanOne.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.Scrolling.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.SendKeys.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.MainApp.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.StagingUIController.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.SyntaxHighlighting.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.TabViewExample.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.TableEditor.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.Text.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.TextAlignments.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.TextAlignmentsAndDirections.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.TextFormatterDemo.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.TextViewAutocompletePopup.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.Threading.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.TimeAndDate.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.TreeUseCases.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.TreeViewFileSystem.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.UnicodeInMenu.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.WindowsAndFrameViews.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.WizardAsView.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.Wizards.html create mode 100644 docs/api/UICatalog/UICatalog.Scenarios.html create mode 100644 docs/api/UICatalog/UICatalog.UICatalogApp.html create mode 100644 docs/api/UICatalog/UICatalog.html create mode 100644 docs/api/UICatalog/toc.html diff --git a/Terminal.Gui/Core/ContextMenu.cs b/Terminal.Gui/Core/ContextMenu.cs index 67346a8322..726fc52c61 100644 --- a/Terminal.Gui/Core/ContextMenu.cs +++ b/Terminal.Gui/Core/ContextMenu.cs @@ -47,7 +47,9 @@ private void MenuBar_MenuAllClosed () Dispose (); } - /// + /// + /// Disposes the all the context menu objects instances. + /// public void Dispose () { if (IsShow) { diff --git a/docs/README.html b/docs/README.html index 79c32d0b25..547ff6f1ce 100644 --- a/docs/README.html +++ b/docs/README.html @@ -8,7 +8,7 @@ To Generate the Docs - + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Application.ResizedEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.Application.ResizedEventArgs.html new file mode 100644 index 0000000000..8eb5f8182f --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Application.ResizedEventArgs.html @@ -0,0 +1,213 @@ + + + + + + + + Class Application.ResizedEventArgs + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+
Search Results for
+
+

+
+
    +
    +
    +
    + +
    + +
    +
    +
    +
    +
    +
    +
    + + +

    Class Application.ResizedEventArgs +

    +
    +Event arguments for the Resized event. +
    +
    +
    +
    Inheritance
    +
    System.Object
    +
    System.EventArgs
    +
    Application.ResizedEventArgs
    +
    +
    +
    Inherited Members
    +
    + System.EventArgs.Empty +
    +
    + System.Object.Equals(System.Object) +
    +
    + System.Object.Equals(System.Object, System.Object) +
    +
    + System.Object.GetHashCode() +
    +
    + System.Object.GetType() +
    +
    + System.Object.MemberwiseClone() +
    +
    + System.Object.ReferenceEquals(System.Object, System.Object) +
    +
    + System.Object.ToString() +
    +
    +
    Namespace: Terminal.Gui
    +
    Assembly: Terminal.Gui.dll
    +
    Syntax
    +
    + 
    public class ResizedEventArgs : EventArgs
    +
    +

    Properties +

    + +

    Cols

    +
    +The number of columns in the resized terminal. +
    +
    +
    Declaration
    +
    + 
    public int Cols { get; set; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Int32
    + +

    Rows

    +
    +The number of rows in the resized terminal. +
    +
    +
    Declaration
    +
    + 
    public int Rows { get; set; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Int32
    +
    +
    + + +
    +
    + + +
    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Application.RunState.html b/docs/api/Terminal.Gui/Terminal.Gui.Application.RunState.html new file mode 100644 index 0000000000..de801d1908 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Application.RunState.html @@ -0,0 +1,266 @@ + + + + + + + + Class Application.RunState + + + + + + + + + + + + + + + + +
    +
    + + + +
    + +
    +
    +
    + +
    +
    Search Results for
    +
    +

    +
    +
      +
      +
      +
      + +
      + +
      +
      +
      +
      +
      +
      +
      + + +

      Class Application.RunState +

      +
      +Captures the execution state for the provided Toplevel view. +
      +
      +
      +
      Inheritance
      +
      System.Object
      +
      Application.RunState
      +
      +
      +
      Implements
      +
      System.IDisposable
      +
      +
      +
      Inherited Members
      +
      + System.Object.Equals(System.Object) +
      +
      + System.Object.Equals(System.Object, System.Object) +
      +
      + System.Object.GetHashCode() +
      +
      + System.Object.GetType() +
      +
      + System.Object.MemberwiseClone() +
      +
      + System.Object.ReferenceEquals(System.Object, System.Object) +
      +
      + System.Object.ToString() +
      +
      +
      Namespace: Terminal.Gui
      +
      Assembly: Terminal.Gui.dll
      +
      Syntax
      +
      + 
      public class RunState : IDisposable
      +
      +

      Constructors +

      + +

      RunState(Toplevel)

      +
      +Initializes a new Application.RunState class. +
      +
      +
      Declaration
      +
      + 
      public RunState(Toplevel view)
      +
      +
      Parameters
      + + + + + + + + + + + + + + + +
      TypeNameDescription
      Toplevelview
      +

      Properties +

      + +

      Toplevel

      +
      +The Toplevel belong to this Application.RunState. +
      +
      +
      Declaration
      +
      + 
      public Toplevel Toplevel { get; }
      +
      +
      Property Value
      + + + + + + + + + + + + + +
      TypeDescription
      Toplevel
      +

      Methods +

      + +

      Dispose()

      +
      +Releases alTop = l resource used by the Application.RunState object. +
      +
      +
      Declaration
      +
      + 
      public void Dispose()
      +
      +
      Remarks
      +
      Call Dispose() when you are finished using the Application.RunState. The +Dispose() method leaves the Application.RunState in an unusable state. After +calling Dispose(), you must release all references to the +Application.RunState so the garbage collector can reclaim the memory that the +Application.RunState was occupying.
      + +

      Dispose(Boolean)

      +
      +Dispose the specified disposing. +
      +
      +
      Declaration
      +
      + 
      protected virtual void Dispose(bool disposing)
      +
      +
      Parameters
      + + + + + + + + + + + + + + + +
      TypeNameDescription
      System.BooleandisposingIf set to true disposing.
      +

      Implements

      +
      + System.IDisposable +
      +
      +
      + + +
      +
      + + +
      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Application.html b/docs/api/Terminal.Gui/Terminal.Gui.Application.html new file mode 100644 index 0000000000..3986ad53e8 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Application.html @@ -0,0 +1,1221 @@ + + + + + + + + Class Application + + + + + + + + + + + + + + + + +
      +
      + + + +
      + +
      +
      +
      + +
      +
      Search Results for
      +
      +

      +
      +
        +
        +
        +
        + +
        + +
        +
        +
        +
        +
        +
        +
        + + +

        Class Application +

        +
        +A static, singleton class providing the main application driver for Terminal.Gui apps. +
        +
        +
        +
        Inheritance
        +
        System.Object
        +
        Application
        +
        +
        +
        Inherited Members
        +
        + System.Object.Equals(System.Object) +
        +
        + System.Object.Equals(System.Object, System.Object) +
        +
        + System.Object.GetHashCode() +
        +
        + System.Object.GetType() +
        +
        + System.Object.MemberwiseClone() +
        +
        + System.Object.ReferenceEquals(System.Object, System.Object) +
        +
        + System.Object.ToString() +
        +
        +
        Namespace: Terminal.Gui
        +
        Assembly: Terminal.Gui.dll
        +
        Syntax
        +
        + 
        public static class Application
        +
        +
        Remarks
        +
        +

        + Creates a instance of MainLoop to process input events, handle timers and + other sources of data. It is accessible via the MainLoop property. +

        +

        + You can hook up to the Iteration event to have your method + invoked on each iteration of the MainLoop. +

        +

        + When invoked sets the SynchronizationContext to one that is tied + to the mainloop, allowing user code to use async/await. +

        +
        +
        Examples
        + +
        // A simple Terminal.Gui app that creates a window with a frame and title with 
+// 5 rows/columns of padding.
+Application.Init();
+var win = new Window ("Hello World - CTRL-Q to quit") {
+    X = 5,
+    Y = 5,
+    Width = Dim.Fill (5),
+    Height = Dim.Fill (5)
+};
+Application.Top.Add(win);
+Application.Run();
        + +

        Fields +

        +

        Driver

        +
        +The current ConsoleDriver in use. +
        +
        +
        Declaration
        +
        + 
        public static ConsoleDriver Driver
        +
        +
        Field Value
        + + + + + + + + + + + + + +
        TypeDescription
        ConsoleDriver
        +

        Iteration

        +
        +This event is raised on each iteration of the MainLoop +
        +
        +
        Declaration
        +
        + 
        public static Action Iteration
        +
        +
        Field Value
        + + + + + + + + + + + + + +
        TypeDescription
        System.Action
        +
        Remarks
        +
        +See also System.Threading.Timeout +
        +

        Resized

        +
        +Invoked when the terminal was resized. The new size of the terminal is provided. +
        +
        +
        Declaration
        +
        + 
        public static Action<Application.ResizedEventArgs> Resized
        +
        +
        Field Value
        + + + + + + + + + + + + + +
        TypeDescription
        System.Action<Application.ResizedEventArgs>
        +

        RootKeyEvent

        +
        +

        +Called for new KeyPress events before any processing is performed or +views evaluate. Use for global key handling and/or debugging. +

        +

        Return true to suppress the KeyPress event

        +
        +
        +
        Declaration
        +
        + 
        public static Func<KeyEvent, bool> RootKeyEvent
        +
        +
        Field Value
        + + + + + + + + + + + + + +
        TypeDescription
        System.Func<KeyEvent, System.Boolean>
        +

        RootMouseEvent

        +
        +Merely a debugging aid to see the raw mouse events +
        +
        +
        Declaration
        +
        + 
        public static Action<MouseEvent> RootMouseEvent
        +
        +
        Field Value
        + + + + + + + + + + + + + +
        TypeDescription
        System.Action<MouseEvent>
        +

        UseSystemConsole

        +
        +If set, it forces the use of the System.Console-based driver. +
        +
        +
        Declaration
        +
        + 
        public static bool UseSystemConsole
        +
        +
        Field Value
        + + + + + + + + + + + + + +
        TypeDescription
        System.Boolean
        +

        Properties +

        + +

        AlternateBackwardKey

        +
        +Alternative key to navigate backwards through all views. Shift+Ctrl+Tab is always used. +
        +
        +
        Declaration
        +
        + 
        public static Key AlternateBackwardKey { get; set; }
        +
        +
        Property Value
        + + + + + + + + + + + + + +
        TypeDescription
        Key
        + +

        AlternateForwardKey

        +
        +Alternative key to navigate forwards through all views. Ctrl+Tab is always used. +
        +
        +
        Declaration
        +
        + 
        public static Key AlternateForwardKey { get; set; }
        +
        +
        Property Value
        + + + + + + + + + + + + + +
        TypeDescription
        Key
        + +

        Current

        +
        +The current Toplevel object. This is updated when Run(Func<Exception, Boolean>) enters and leaves to point to the current Toplevel . +
        +
        +
        Declaration
        +
        + 
        public static Toplevel Current { get; }
        +
        +
        Property Value
        + + + + + + + + + + + + + +
        TypeDescription
        ToplevelThe current.
        + +

        ExitRunLoopAfterFirstIteration

        +
        +Set to true to cause the RunLoop method to exit after the first iterations. +Set to false (the default) to cause the RunLoop to continue running until Application.RequestStop() is called. +
        +
        +
        Declaration
        +
        + 
        public static bool ExitRunLoopAfterFirstIteration { get; set; }
        +
        +
        Property Value
        + + + + + + + + + + + + + +
        TypeDescription
        System.Boolean
        + +

        HeightAsBuffer

        +
        +The current HeightAsBuffer used in the terminal. +
        +
        +
        Declaration
        +
        + 
        public static bool HeightAsBuffer { get; set; }
        +
        +
        Property Value
        + + + + + + + + + + + + + +
        TypeDescription
        System.Boolean
        + +

        IsMouseDisabled

        +
        +Disable or enable the mouse in this Application +
        +
        +
        Declaration
        +
        + 
        public static bool IsMouseDisabled { get; set; }
        +
        +
        Property Value
        + + + + + + + + + + + + + +
        TypeDescription
        System.Boolean
        + +

        MainLoop

        +
        +The MainLoop driver for the application +
        +
        +
        Declaration
        +
        + 
        public static MainLoop MainLoop { get; }
        +
        +
        Property Value
        + + + + + + + + + + + + + +
        TypeDescription
        MainLoopThe main loop.
        + +

        MdiChildes

        +
        +Gets all the Mdi childes which represent all the not modal Toplevel from the MdiTop. +
        +
        +
        Declaration
        +
        + 
        public static List<Toplevel> MdiChildes { get; }
        +
        +
        Property Value
        + + + + + + + + + + + + + +
        TypeDescription
        System.Collections.Generic.List<Toplevel>
        + +

        MdiTop

        +
        +The Toplevel object used for the application on startup which IsMdiContainer is true. +
        +
        +
        Declaration
        +
        + 
        public static Toplevel MdiTop { get; }
        +
        +
        Property Value
        + + + + + + + + + + + + + +
        TypeDescription
        Toplevel
        + +

        QuitKey

        +
        +Gets or sets the key to quit the application. +
        +
        +
        Declaration
        +
        + 
        public static Key QuitKey { get; set; }
        +
        +
        Property Value
        + + + + + + + + + + + + + +
        TypeDescription
        Key
        + +

        SupportedCultures

        +
        +Gets all supported cultures by the application without the invariant language. +
        +
        +
        Declaration
        +
        + 
        public static List<CultureInfo> SupportedCultures { get; }
        +
        +
        Property Value
        + + + + + + + + + + + + + +
        TypeDescription
        System.Collections.Generic.List<System.Globalization.CultureInfo>
        + +

        Top

        +
        +The Toplevel object used for the application on startup (Top) +
        +
        +
        Declaration
        +
        + 
        public static Toplevel Top { get; }
        +
        +
        Property Value
        + + + + + + + + + + + + + +
        TypeDescription
        ToplevelThe top.
        + +

        WantContinuousButtonPressedView

        +
        +The current View object that wants continuous mouse button pressed events. +
        +
        +
        Declaration
        +
        + 
        public static View WantContinuousButtonPressedView { get; }
        +
        +
        Property Value
        + + + + + + + + + + + + + +
        TypeDescription
        View
        +

        Methods +

        + +

        Begin(Toplevel)

        +
        +Building block API: Prepares the provided Toplevel for execution. +
        +
        +
        Declaration
        +
        + 
        public static Application.RunState Begin(Toplevel toplevel)
        +
        +
        Parameters
        + + + + + + + + + + + + + + + +
        TypeNameDescription
        TopleveltoplevelToplevel to prepare execution for.
        +
        Returns
        + + + + + + + + + + + + + +
        TypeDescription
        Application.RunStateThe runstate handle that needs to be passed to the End(Application.RunState) method upon completion.
        +
        Remarks
        +
        +This method prepares the provided toplevel for running with the focus, +it adds this to the list of toplevels, sets up the mainloop to process the +event, lays out the subviews, focuses the first element, and draws the +toplevel in the screen. This is usually followed by executing +the RunLoop(Application.RunState, Boolean) method, and then the End(Application.RunState) method upon termination which will +undo these changes. +
        + +

        DoEvents()

        +
        +Wakes up the mainloop that might be waiting on input, must be thread safe. +
        +
        +
        Declaration
        +
        + 
        public static void DoEvents()
        +
        + +

        End(Application.RunState)

        +
        +Building block API: completes the execution of a Toplevel that was started with Begin(Toplevel) . +
        +
        +
        Declaration
        +
        + 
        public static void End(Application.RunState runState)
        +
        +
        Parameters
        + + + + + + + + + + + + + + + +
        TypeNameDescription
        Application.RunStaterunStateThe runstate returned by the Begin(Toplevel) method.
        + +

        EnsuresTopOnFront()

        +
        +Ensures that the superview of the most focused view is on front. +
        +
        +
        Declaration
        +
        + 
        public static void EnsuresTopOnFront()
        +
        + +

        GrabMouse(View)

        +
        +Grabs the mouse, forcing all mouse events to be routed to the specified view until UngrabMouse is called. +
        +
        +
        Declaration
        +
        + 
        public static void GrabMouse(View view)
        +
        +
        Parameters
        + + + + + + + + + + + + + + + +
        TypeNameDescription
        ViewviewView that will receive all mouse events until UngrabMouse is invoked.
        + +

        Init(ConsoleDriver, IMainLoopDriver)

        +
        +Initializes a new instance of Terminal.Gui Application. +
        +
        +
        Declaration
        +
        + 
        public static void Init(ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null)
        +
        +
        Parameters
        + + + + + + + + + + + + + + + + + + + + +
        TypeNameDescription
        ConsoleDriverdriver
        IMainLoopDrivermainLoopDriver
        +
        Remarks
        +
        +

        +Call this method once per instance (or after Shutdown() has been called). +

        +

        +Loads the right ConsoleDriver for the platform. +

        +

        +Creates a Toplevel and assigns it to Top +

        +
        + +

        MakeCenteredRect(Size)

        +
        +Returns a rectangle that is centered in the screen for the provided size. +
        +
        +
        Declaration
        +
        + 
        public static Rect MakeCenteredRect(Size size)
        +
        +
        Parameters
        + + + + + + + + + + + + + + + +
        TypeNameDescription
        SizesizeSize for the rectangle.
        +
        Returns
        + + + + + + + + + + + + + +
        TypeDescription
        RectThe centered rect.
        + +

        MoveNext()

        +
        +Move to the next Mdi child from the MdiTop. +
        +
        +
        Declaration
        +
        + 
        public static void MoveNext()
        +
        + +

        MovePrevious()

        +
        +Move to the previous Mdi child from the MdiTop. +
        +
        +
        Declaration
        +
        + 
        public static void MovePrevious()
        +
        + +

        Refresh()

        +
        +Triggers a refresh of the entire display. +
        +
        +
        Declaration
        +
        + 
        public static void Refresh()
        +
        + +

        RequestStop(Toplevel)

        +
        +Stops running the most recent Toplevel or the top if provided. +
        +
        +
        Declaration
        +
        + 
        public static void RequestStop(Toplevel top = null)
        +
        +
        Parameters
        + + + + + + + + + + + + + + + +
        TypeNameDescription
        TopleveltopThe toplevel to request stop.
        +
        Remarks
        +
        +

        +This will cause Run(Func<Exception, Boolean>) to return. +

        +

        + Calling RequestStop(Toplevel) is equivalent to setting the Running property on the currently running Toplevel to false. +

        +
        + +

        Run(Func<Exception, Boolean>)

        +
        +Runs the application by calling Run(Toplevel, Func<Exception, Boolean>) with the value of Top +
        +
        +
        Declaration
        +
        + 
        public static void Run(Func<Exception, bool> errorHandler = null)
        +
        +
        Parameters
        + + + + + + + + + + + + + + + +
        TypeNameDescription
        System.Func<System.Exception, System.Boolean>errorHandler
        + +

        Run(Toplevel, Func<Exception, Boolean>)

        +
        +Runs the main loop on the given Toplevel container. +
        +
        +
        Declaration
        +
        + 
        public static void Run(Toplevel view, Func<Exception, bool> errorHandler = null)
        +
        +
        Parameters
        + + + + + + + + + + + + + + + + + + + + +
        TypeNameDescription
        ToplevelviewThe Toplevel to run modally.
        System.Func<System.Exception, System.Boolean>errorHandlerHandler for any unhandled exceptions (resumes when returns true, rethrows when null).
        +
        Remarks
        +
        +

        + This method is used to start processing events + for the main application, but it is also used to + run other modal Views such as Dialog boxes. +

        +

        + To make a Run(Toplevel, Func<Exception, Boolean>) stop execution, call RequestStop(Toplevel). +

        +

        + Calling Run(Toplevel, Func<Exception, Boolean>) is equivalent to calling Begin(Toplevel), followed by RunLoop(Application.RunState, Boolean), + and then calling End(Application.RunState). +

        +

        + Alternatively, to have a program control the main loop and + process events manually, call Begin(Toplevel) to set things up manually and then + repeatedly call RunLoop(Application.RunState, Boolean) with the wait parameter set to false. By doing this + the RunLoop(Application.RunState, Boolean) method will only process any pending events, timers, idle handlers and + then return control immediately. +

        +

        + When errorHandler is null the exception is rethrown, when it returns true the application is resumed and when false method exits gracefully. +

        +
        + +

        Run<T>(Func<Exception, Boolean>)

        +
        +Runs the application by calling Run(Toplevel, Func<Exception, Boolean>) with a new instance of the specified Toplevel-derived class +
        +
        +
        Declaration
        +
        + 
        public static void Run<T>(Func<Exception, bool> errorHandler = null)
+
+    where T : Toplevel, new()
        +
        +
        Parameters
        + + + + + + + + + + + + + + + +
        TypeNameDescription
        System.Func<System.Exception, System.Boolean>errorHandler
        +
        Type Parameters
        + + + + + + + + + + + + + +
        NameDescription
        T
        + +

        RunLoop(Application.RunState, Boolean)

        +
        +Building block API: Runs the main loop for the created dialog +
        +
        +
        Declaration
        +
        + 
        public static void RunLoop(Application.RunState state, bool wait = true)
        +
        +
        Parameters
        + + + + + + + + + + + + + + + + + + + + +
        TypeNameDescription
        Application.RunStatestateThe state returned by the Begin method.
        System.BooleanwaitBy default this is true which will execute the runloop waiting for events, if you pass false, you can use this method to run a single iteration of the events.
        +
        Remarks
        +
        +Use the wait parameter to control whether this is a +blocking or non-blocking call. +
        + +

        RunMainLoopIteration(ref Application.RunState, Boolean, ref Boolean)

        +
        +Run one iteration of the MainLoop. +
        +
        +
        Declaration
        +
        + 
        public static void RunMainLoopIteration(ref Application.RunState state, bool wait, ref bool firstIteration)
        +
        +
        Parameters
        + + + + + + + + + + + + + + + + + + + + + + + + + +
        TypeNameDescription
        Application.RunStatestateThe state returned by the Begin method.
        System.BooleanwaitIf will execute the runloop waiting for events.
        System.BooleanfirstIterationIf it's the first run loop iteration.
        + +

        Shutdown()

        +
        +Shutdown an application initialized with Init(ConsoleDriver, IMainLoopDriver) +
        +
        +
        Declaration
        +
        + 
        public static void Shutdown()
        +
        + +

        UngrabMouse()

        +
        +Releases the mouse grab, so mouse events will be routed to the view on which the mouse is. +
        +
        +
        Declaration
        +
        + 
        public static void UngrabMouse()
        +
        +

        Events +

        +

        NotifyNewRunState

        +
        +Notify that a new Application.RunState token was created, +used if ExitRunLoopAfterFirstIteration is true. +
        +
        +
        Declaration
        +
        + 
        public static event Action<Application.RunState> NotifyNewRunState
        +
        +
        Event Type
        + + + + + + + + + + + + + +
        TypeDescription
        System.Action<Application.RunState>
        +

        NotifyStopRunState

        +
        +Notify that a existent Application.RunState token is stopping, +used if ExitRunLoopAfterFirstIteration is true. +
        +
        +
        Declaration
        +
        + 
        public static event Action<Toplevel> NotifyStopRunState
        +
        +
        Event Type
        + + + + + + + + + + + + + +
        TypeDescription
        System.Action<Toplevel>
        +
        +
        + + +
        +
        + + +
        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Attribute.html b/docs/api/Terminal.Gui/Terminal.Gui.Attribute.html new file mode 100644 index 0000000000..f737ac2b70 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Attribute.html @@ -0,0 +1,519 @@ + + + + + + + + Struct Attribute + + + + + + + + + + + + + + + + +
        +
        + + + +
        + +
        +
        +
        + +
        +
        Search Results for
        +
        +

        +
        +
          +
          +
          +
          + +
          + +
          +
          +
          +
          +
          +
          +
          + + +

          Struct Attribute +

          +
          +Attributes are used as elements that contain both a foreground and a background or platform specific features +
          +
          +
          +
          Inherited Members
          +
          + System.ValueType.Equals(System.Object) +
          +
          + System.ValueType.GetHashCode() +
          +
          + System.ValueType.ToString() +
          +
          + System.Object.Equals(System.Object, System.Object) +
          +
          + System.Object.GetType() +
          +
          + System.Object.ReferenceEquals(System.Object, System.Object) +
          +
          +
          Namespace: Terminal.Gui
          +
          Assembly: Terminal.Gui.dll
          +
          Syntax
          +
          + 
          public struct Attribute
          +
          +
          Remarks
          +
          +Attributes are needed to map colors to terminal capabilities that might lack colors, on color +scenarios, they encode both the foreground and the background color and are used in the ColorScheme +class to define color schemes that can be used in your application. +
          +

          Constructors +

          + +

          Attribute(Int32)

          +
          +Initializes a new instance of the Attribute struct with only the value passed to +and trying to get the colors if defined. +
          +
          +
          Declaration
          +
          + 
          public Attribute(int value)
          +
          +
          Parameters
          + + + + + + + + + + + + + + + +
          TypeNameDescription
          System.Int32valueValue.
          + +

          Attribute(Int32, Color, Color)

          +
          +Initializes a new instance of the Attribute struct. +
          +
          +
          Declaration
          +
          + 
          public Attribute(int value, Color foreground, Color background)
          +
          +
          Parameters
          + + + + + + + + + + + + + + + + + + + + + + + + + +
          TypeNameDescription
          System.Int32valueValue.
          ColorforegroundForeground
          ColorbackgroundBackground
          + +

          Attribute(Color)

          +
          +Initializes a new instance of the Attribute struct +with the same colors for the foreground and background. +
          +
          +
          Declaration
          +
          + 
          public Attribute(Color color)
          +
          +
          Parameters
          + + + + + + + + + + + + + + + +
          TypeNameDescription
          ColorcolorThe color.
          + +

          Attribute(Color, Color)

          +
          +Initializes a new instance of the Attribute struct. +
          +
          +
          Declaration
          +
          + 
          public Attribute(Color foreground = Color.Black, Color background = Color.Black)
          +
          +
          Parameters
          + + + + + + + + + + + + + + + + + + + + +
          TypeNameDescription
          ColorforegroundForeground
          ColorbackgroundBackground
          +

          Properties +

          + +

          Background

          +
          +The background color. +
          +
          +
          Declaration
          +
          + 
          public readonly Color Background { get; }
          +
          +
          Property Value
          + + + + + + + + + + + + + +
          TypeDescription
          Color
          + +

          Foreground

          +
          +The foreground color. +
          +
          +
          Declaration
          +
          + 
          public readonly Color Foreground { get; }
          +
          +
          Property Value
          + + + + + + + + + + + + + +
          TypeDescription
          Color
          + +

          Value

          +
          +The color attribute value. +
          +
          +
          Declaration
          +
          + 
          public readonly int Value { get; }
          +
          +
          Property Value
          + + + + + + + + + + + + + +
          TypeDescription
          System.Int32
          +

          Methods +

          + +

          Get()

          +
          +Gets the current Attribute from the driver. +
          +
          +
          Declaration
          +
          + 
          public static Attribute Get()
          +
          +
          Returns
          + + + + + + + + + + + + + +
          TypeDescription
          AttributeThe current attribute.
          + +

          Make(Color, Color)

          +
          +Creates an Attribute from the specified foreground and background. +
          +
          +
          Declaration
          +
          + 
          public static Attribute Make(Color foreground, Color background)
          +
          +
          Parameters
          + + + + + + + + + + + + + + + + + + + + +
          TypeNameDescription
          ColorforegroundForeground color to use.
          ColorbackgroundBackground color to use.
          +
          Returns
          + + + + + + + + + + + + + +
          TypeDescription
          AttributeThe make.
          +

          Operators +

          + +

          Implicit(Int32 to Attribute)

          +
          +Implicitly convert an integer value into an Attribute +
          +
          +
          Declaration
          +
          + 
          public static implicit operator Attribute(int v)
          +
          +
          Parameters
          + + + + + + + + + + + + + + + +
          TypeNameDescription
          System.Int32vvalue
          +
          Returns
          + + + + + + + + + + + + + +
          TypeDescription
          AttributeAn attribute with the specified integer value.
          + +

          Implicit(Attribute to Int32)

          +
          +Implicit conversion from an Attribute to the underlying Int32 representation +
          +
          +
          Declaration
          +
          + 
          public static implicit operator int (Attribute c)
          +
          +
          Parameters
          + + + + + + + + + + + + + + + +
          TypeNameDescription
          AttributecThe attribute to convert
          +
          Returns
          + + + + + + + + + + + + + +
          TypeDescription
          System.Int32The integer value stored in the attribute.
          +
          +
          + + +
          +
          + + +
          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Autocomplete.html b/docs/api/Terminal.Gui/Terminal.Gui.Autocomplete.html new file mode 100644 index 0000000000..b78affa1f5 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Autocomplete.html @@ -0,0 +1,967 @@ + + + + + + + + Class Autocomplete + + + + + + + + + + + + + + + + +
          +
          + + + +
          + +
          +
          +
          + +
          +
          Search Results for
          +
          +

          +
          +
            +
            +
            +
            + +
            + +
            +
            +
            +
            +
            +
            +
            + + +

            Class Autocomplete +

            +
            +Renders an overlay on another view at a given point that allows selecting +from a range of 'autocomplete' options. +
            +
            +
            +
            Inheritance
            +
            System.Object
            +
            Autocomplete
            +
            TextFieldAutocomplete
            +
            TextViewAutocomplete
            +
            +
            +
            Implements
            + +
            +
            +
            Inherited Members
            +
            + System.Object.Equals(System.Object) +
            +
            + System.Object.Equals(System.Object, System.Object) +
            +
            + System.Object.GetHashCode() +
            +
            + System.Object.GetType() +
            +
            + System.Object.MemberwiseClone() +
            +
            + System.Object.ReferenceEquals(System.Object, System.Object) +
            +
            + System.Object.ToString() +
            +
            +
            Namespace: Terminal.Gui
            +
            Assembly: Terminal.Gui.dll
            +
            Syntax
            +
            + 
            public abstract class Autocomplete : IAutocomplete
            +
            +

            Properties +

            + +

            AllSuggestions

            +
            +The full set of all strings that can be suggested. +
            +
            +
            Declaration
            +
            + 
            public virtual List<string> AllSuggestions { get; set; }
            +
            +
            Property Value
            + + + + + + + + + + + + + +
            TypeDescription
            System.Collections.Generic.List<System.String>
            + +

            CloseKey

            +
            +The key that the user can press to close the currently popped autocomplete menu +
            +
            +
            Declaration
            +
            + 
            public virtual Key CloseKey { get; set; }
            +
            +
            Property Value
            + + + + + + + + + + + + + +
            TypeDescription
            Key
            + +

            ColorScheme

            +
            +The colors to use to render the overlay. Accessing this property before +the Application has been initialized will cause an error +
            +
            +
            Declaration
            +
            + 
            public virtual ColorScheme ColorScheme { get; set; }
            +
            +
            Property Value
            + + + + + + + + + + + + + +
            TypeDescription
            ColorScheme
            + +

            HostControl

            +
            +The host control to handle. +
            +
            +
            Declaration
            +
            + 
            public virtual View HostControl { get; set; }
            +
            +
            Property Value
            + + + + + + + + + + + + + +
            TypeDescription
            View
            + +

            MaxHeight

            +
            +The maximum number of visible rows in the autocomplete dropdown to render +
            +
            +
            Declaration
            +
            + 
            public virtual int MaxHeight { get; set; }
            +
            +
            Property Value
            + + + + + + + + + + + + + +
            TypeDescription
            System.Int32
            + +

            MaxWidth

            +
            +The maximum width of the autocomplete dropdown +
            +
            +
            Declaration
            +
            + 
            public virtual int MaxWidth { get; set; }
            +
            +
            Property Value
            + + + + + + + + + + + + + +
            TypeDescription
            System.Int32
            + +

            PopupInsideContainer

            +
            +Gets or sets If the popup is displayed inside or outside the host limits. +
            +
            +
            Declaration
            +
            + 
            public bool PopupInsideContainer { get; set; }
            +
            +
            Property Value
            + + + + + + + + + + + + + +
            TypeDescription
            System.Boolean
            + +

            Reopen

            +
            +The key that the user can press to reopen the currently popped autocomplete menu +
            +
            +
            Declaration
            +
            + 
            public virtual Key Reopen { get; set; }
            +
            +
            Property Value
            + + + + + + + + + + + + + +
            TypeDescription
            Key
            + +

            ScrollOffset

            +
            +When more suggestions are available than can be rendered the user +can scroll down the dropdown list. This indicates how far down they +have gone +
            +
            +
            Declaration
            +
            + 
            public virtual int ScrollOffset { get; set; }
            +
            +
            Property Value
            + + + + + + + + + + + + + +
            TypeDescription
            System.Int32
            + +

            SelectedIdx

            +
            +The currently selected index into Suggestions that the user has highlighted +
            +
            +
            Declaration
            +
            + 
            public virtual int SelectedIdx { get; set; }
            +
            +
            Property Value
            + + + + + + + + + + + + + +
            TypeDescription
            System.Int32
            + +

            SelectionKey

            +
            +The key that the user must press to accept the currently selected autocomplete suggestion +
            +
            +
            Declaration
            +
            + 
            public virtual Key SelectionKey { get; set; }
            +
            +
            Property Value
            + + + + + + + + + + + + + +
            TypeDescription
            Key
            + +

            Suggestions

            +
            +The strings that form the current list of suggestions to render +based on what the user has typed so far. +
            +
            +
            Declaration
            +
            + 
            public virtual ReadOnlyCollection<string> Suggestions { get; set; }
            +
            +
            Property Value
            + + + + + + + + + + + + + +
            TypeDescription
            System.Collections.ObjectModel.ReadOnlyCollection<System.String>
            + +

            Visible

            +
            +True if the autocomplete should be considered open and visible +
            +
            +
            Declaration
            +
            + 
            public virtual bool Visible { get; set; }
            +
            +
            Property Value
            + + + + + + + + + + + + + +
            TypeDescription
            System.Boolean
            +

            Methods +

            + +

            ClearSuggestions()

            +
            +Clears Suggestions +
            +
            +
            Declaration
            +
            + 
            public virtual void ClearSuggestions()
            +
            + +

            Close()

            +
            +Closes the Autocomplete context menu if it is showing and ClearSuggestions() +
            +
            +
            Declaration
            +
            + 
            protected void Close()
            +
            + +

            DeleteTextBackwards()

            +
            +Deletes the text backwards before insert the selected text in the HostControl. +
            +
            +
            Declaration
            +
            + 
            protected abstract void DeleteTextBackwards()
            +
            + +

            EnsureSelectedIdxIsValid()

            +
            +Updates SelectedIdx to be a valid index within Suggestions +
            +
            +
            Declaration
            +
            + 
            public virtual void EnsureSelectedIdxIsValid()
            +
            + +

            GenerateSuggestions()

            +
            +Populates Suggestions with all strings in AllSuggestions that +match with the current cursor position/text in the HostControl +
            +
            +
            Declaration
            +
            + 
            public virtual void GenerateSuggestions()
            +
            + +

            GetCurrentWord()

            +
            +Returns the currently selected word from the HostControl. +

            +When overriding this method views can make use of IdxToWord(List<Rune>, Int32) +

            +
            +
            +
            Declaration
            +
            + 
            protected abstract string GetCurrentWord()
            +
            +
            Returns
            + + + + + + + + + + + + + +
            TypeDescription
            System.String
            + +

            IdxToWord(List<Rune>, Int32)

            +
            +

            +Given a line of characters, returns the word which ends at idx +or null. Also returns null if the idx is positioned in the middle of a word. +

            + +

            Use this method to determine whether autocomplete should be shown when the cursor is at +a given point in a line and to get the word from which suggestions should be generated.

            +
            +
            +
            Declaration
            +
            + 
            protected virtual string IdxToWord(List<Rune> line, int idx)
            +
            +
            Parameters
            + + + + + + + + + + + + + + + + + + + + +
            TypeNameDescription
            System.Collections.Generic.List<System.Rune>line
            System.Int32idx
            +
            Returns
            + + + + + + + + + + + + + +
            TypeDescription
            System.String
            + +

            InsertSelection(String)

            +
            +Called when the user confirms a selection at the current cursor location in +the HostControl. The accepted string +is the full autocomplete word to be inserted. Typically a host will have to +remove some characters such that the accepted string +completes the word instead of simply being appended. +
            +
            +
            Declaration
            +
            + 
            protected virtual bool InsertSelection(string accepted)
            +
            +
            Parameters
            + + + + + + + + + + + + + + + +
            TypeNameDescription
            System.Stringaccepted
            +
            Returns
            + + + + + + + + + + + + + +
            TypeDescription
            System.BooleanTrue if the insertion was possible otherwise false
            + +

            InsertText(String)

            +
            +Inser the selected text in the HostControl. +
            +
            +
            Declaration
            +
            + 
            protected abstract void InsertText(string accepted)
            +
            +
            Parameters
            + + + + + + + + + + + + + + + +
            TypeNameDescription
            System.Stringaccepted
            + +

            IsWordChar(Rune)

            +
            +Return true if the given symbol should be considered part of a word +and can be contained in matches. Base behavior is to use System.Char.IsLetterOrDigit(System.Char) +
            +
            +
            Declaration
            +
            + 
            public virtual bool IsWordChar(Rune rune)
            +
            +
            Parameters
            + + + + + + + + + + + + + + + +
            TypeNameDescription
            System.Runerune
            +
            Returns
            + + + + + + + + + + + + + +
            TypeDescription
            System.Boolean
            + +

            MouseEvent(MouseEvent, Boolean)

            +
            +Handle mouse events before HostControl e.g. to make mouse events like +report/click apply to the autocomplete control instead of changing the cursor position in +the underlying text view. +
            +
            +
            Declaration
            +
            + 
            public virtual bool MouseEvent(MouseEvent me, bool fromHost = false)
            +
            +
            Parameters
            + + + + + + + + + + + + + + + + + + + + +
            TypeNameDescription
            MouseEventmeThe mouse event.
            System.BooleanfromHostIf was called from the popup or from the host.
            +
            Returns
            + + + + + + + + + + + + + +
            TypeDescription
            System.Booleantrueif the mouse can be handled falseotherwise.
            + +

            MoveDown()

            +
            +Moves the selection in the Autocomplete context menu down one +
            +
            +
            Declaration
            +
            + 
            protected void MoveDown()
            +
            + +

            MoveUp()

            +
            +Moves the selection in the Autocomplete context menu up one +
            +
            +
            Declaration
            +
            + 
            protected void MoveUp()
            +
            + +

            ProcessKey(KeyEvent)

            +
            +Handle key events before HostControl e.g. to make key events like +up/down apply to the autocomplete control instead of changing the cursor position in +the underlying text view. +
            +
            +
            Declaration
            +
            + 
            public virtual bool ProcessKey(KeyEvent kb)
            +
            +
            Parameters
            + + + + + + + + + + + + + + + +
            TypeNameDescription
            KeyEventkbThe key event.
            +
            Returns
            + + + + + + + + + + + + + +
            TypeDescription
            System.Booleantrueif the key can be handled falseotherwise.
            + +

            RenderOverlay(Point)

            +
            +Renders the autocomplete dialog inside or outside the given HostControl at the +given point. +
            +
            +
            Declaration
            +
            + 
            public virtual void RenderOverlay(Point renderAt)
            +
            +
            Parameters
            + + + + + + + + + + + + + + + +
            TypeNameDescription
            PointrenderAt
            + +

            RenderSelectedIdxByMouse(MouseEvent)

            +
            +Render the current selection in the Autocomplete context menu by the mouse reporting. +
            +
            +
            Declaration
            +
            + 
            protected void RenderSelectedIdxByMouse(MouseEvent me)
            +
            +
            Parameters
            + + + + + + + + + + + + + + + +
            TypeNameDescription
            MouseEventme
            + +

            ReopenSuggestions()

            +
            +Reopen the popup after it has been closed. +
            +
            +
            Declaration
            +
            + 
            protected bool ReopenSuggestions()
            +
            +
            Returns
            + + + + + + + + + + + + + +
            TypeDescription
            System.Boolean
            + +

            Select()

            +
            +Completes the autocomplete selection process. Called when user hits the SelectionKey. +
            +
            +
            Declaration
            +
            + 
            protected bool Select()
            +
            +
            Returns
            + + + + + + + + + + + + + +
            TypeDescription
            System.Boolean
            +

            Implements

            + +
            +
            + + +
            +
            + + +
            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Border.ToplevelContainer.html b/docs/api/Terminal.Gui/Terminal.Gui.Border.ToplevelContainer.html new file mode 100644 index 0000000000..d1e3d7a012 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Border.ToplevelContainer.html @@ -0,0 +1,891 @@ + + + + + + + + Class Border.ToplevelContainer + + + + + + + + + + + + + + + + +
            +
            + + + +
            + +
            +
            +
            + +
            +
            Search Results for
            +
            +

            +
            +
              +
              +
              +
              + +
              + +
              +
              +
              +
              +
              +
              +
              + + +

              Class Border.ToplevelContainer +

              +
              +A sealed Toplevel derived class to implement Border feature. +This is only a wrapper to get borders on a toplevel and is recommended using another +derived, like Window where is possible to have borders with or without +border line or spacing around. +
              +
              +
              +
              Inheritance
              +
              System.Object
              +
              Responder
              +
              View
              +
              Toplevel
              +
              Border.ToplevelContainer
              +
              +
              +
              Implements
              +
              System.IDisposable
              +
              System.ComponentModel.ISupportInitializeNotification
              +
              System.ComponentModel.ISupportInitialize
              +
              +
              +
              Inherited Members
              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
              + View.Data +
              + + + + + +
              + View.Id +
              + + + + + + +
              + View.X +
              +
              + View.Y +
              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
              + View.Text +
              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
              + System.Object.Equals(System.Object) +
              +
              + System.Object.Equals(System.Object, System.Object) +
              +
              + System.Object.GetHashCode() +
              +
              + System.Object.GetType() +
              +
              + System.Object.MemberwiseClone() +
              +
              + System.Object.ReferenceEquals(System.Object, System.Object) +
              +
              +
              Namespace: Terminal.Gui
              +
              Assembly: Terminal.Gui.dll
              +
              Syntax
              +
              + 
              public sealed class ToplevelContainer : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize
              +
              +

              Constructors +

              + +

              ToplevelContainer()

              +
              +Initializes with default null values. +
              +
              +
              Declaration
              +
              + 
              public ToplevelContainer()
              +
              + +

              ToplevelContainer(Border, String)

              +
              +Initializes a Border.ToplevelContainer with a Computed +
              +
              +
              Declaration
              +
              + 
              public ToplevelContainer(Border border, string title = null)
              +
              +
              Parameters
              + + + + + + + + + + + + + + + + + + + + +
              TypeNameDescription
              BorderborderThe border.
              System.StringtitleThe title.
              + +

              ToplevelContainer(Rect, Border, String)

              +
              +Initializes a Border.ToplevelContainer with a Absolute +
              +
              +
              Declaration
              +
              + 
              public ToplevelContainer(Rect frame, Border border, string title = null)
              +
              +
              Parameters
              + + + + + + + + + + + + + + + + + + + + + + + + + +
              TypeNameDescription
              RectframeThe frame.
              BorderborderThe border.
              System.StringtitleThe title.
              +

              Properties +

              + +

              Border

              +
              +
              +
              Declaration
              +
              + 
              public override Border Border { get; set; }
              +
              +
              Property Value
              + + + + + + + + + + + + + +
              TypeDescription
              Border
              +
              Overrides
              + +

              Methods +

              + +

              Add(View)

              +
              +
              +
              Declaration
              +
              + 
              public override void Add(View view)
              +
              +
              Parameters
              + + + + + + + + + + + + + + + +
              TypeNameDescription
              Viewview
              +
              Overrides
              + + +

              OnCanFocusChanged()

              +
              +
              +
              Declaration
              +
              + 
              public override void OnCanFocusChanged()
              +
              +
              Overrides
              + + +

              Redraw(Rect)

              +
              +
              +
              Declaration
              +
              + 
              public override void Redraw(Rect bounds)
              +
              +
              Parameters
              + + + + + + + + + + + + + + + +
              TypeNameDescription
              Rectbounds
              +
              Overrides
              + + +

              Remove(View)

              +
              +
              +
              Declaration
              +
              + 
              public override void Remove(View view)
              +
              +
              Parameters
              + + + + + + + + + + + + + + + +
              TypeNameDescription
              Viewview
              +
              Overrides
              + + +

              RemoveAll()

              +
              +
              +
              Declaration
              +
              + 
              public override void RemoveAll()
              +
              +
              Overrides
              + +

              Implements

              +
              + System.IDisposable +
              +
              + System.ComponentModel.ISupportInitializeNotification +
              +
              + System.ComponentModel.ISupportInitialize +
              +
              +
              + + +
              +
              + + +
              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Border.html b/docs/api/Terminal.Gui/Terminal.Gui.Border.html new file mode 100644 index 0000000000..6892616a5d --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Border.html @@ -0,0 +1,648 @@ + + + + + + + + Class Border + + + + + + + + + + + + + + + + +
              +
              + + + +
              + +
              +
              +
              + +
              +
              Search Results for
              +
              +

              +
              +
                +
                +
                +
                + +
                + +
                +
                +
                +
                +
                +
                +
                + + +

                Class Border +

                +
                +Draws a border, background, or both around another element. +
                +
                +
                +
                Inheritance
                +
                System.Object
                +
                Border
                +
                +
                +
                Inherited Members
                +
                + System.Object.Equals(System.Object) +
                +
                + System.Object.Equals(System.Object, System.Object) +
                +
                + System.Object.GetHashCode() +
                +
                + System.Object.GetType() +
                +
                + System.Object.MemberwiseClone() +
                +
                + System.Object.ReferenceEquals(System.Object, System.Object) +
                +
                + System.Object.ToString() +
                +
                +
                Namespace: Terminal.Gui
                +
                Assembly: Terminal.Gui.dll
                +
                Syntax
                +
                + 
                public class Border
                +
                +

                Properties +

                + +

                ActualHeight

                +
                +Gets the rendered height of this element. +
                +
                +
                Declaration
                +
                + 
                public int ActualHeight { get; }
                +
                +
                Property Value
                + + + + + + + + + + + + + +
                TypeDescription
                System.Int32
                + +

                ActualWidth

                +
                +Gets the rendered width of this element. +
                +
                +
                Declaration
                +
                + 
                public int ActualWidth { get; }
                +
                +
                Property Value
                + + + + + + + + + + + + + +
                TypeDescription
                System.Int32
                + +

                Background

                +
                +Gets or sets the Color that fills the area between the bounds of a Border. +
                +
                +
                Declaration
                +
                + 
                public Color Background { get; set; }
                +
                +
                Property Value
                + + + + + + + + + + + + + +
                TypeDescription
                Color
                + +

                BorderBrush

                +
                +Gets or sets the Color that draws the outer border color. +
                +
                +
                Declaration
                +
                + 
                public Color BorderBrush { get; set; }
                +
                +
                Property Value
                + + + + + + + + + + + + + +
                TypeDescription
                Color
                + +

                BorderStyle

                +
                +Specifies the BorderStyle for a view. +
                +
                +
                Declaration
                +
                + 
                public BorderStyle BorderStyle { get; set; }
                +
                +
                Property Value
                + + + + + + + + + + + + + +
                TypeDescription
                BorderStyle
                + +

                BorderThickness

                +
                +Gets or sets the relative Thickness of a Border. +
                +
                +
                Declaration
                +
                + 
                public Thickness BorderThickness { get; set; }
                +
                +
                Property Value
                + + + + + + + + + + + + + +
                TypeDescription
                Thickness
                + +

                Child

                +
                +Gets or sets the single child element of a View. +
                +
                +
                Declaration
                +
                + 
                public View Child { get; set; }
                +
                +
                Property Value
                + + + + + + + + + + + + + +
                TypeDescription
                View
                + +

                ChildContainer

                +
                +Gets or private sets by the Border.ToplevelContainer +
                +
                +
                Declaration
                +
                + 
                public Border.ToplevelContainer ChildContainer { get; }
                +
                +
                Property Value
                + + + + + + + + + + + + + +
                TypeDescription
                Border.ToplevelContainer
                + +

                DrawMarginFrame

                +
                +Gets or sets if a margin frame is drawn around the Child regardless the BorderStyle +
                +
                +
                Declaration
                +
                + 
                public bool DrawMarginFrame { get; set; }
                +
                +
                Property Value
                + + + + + + + + + + + + + +
                TypeDescription
                System.Boolean
                + +

                Effect3D

                +
                +Gets or sets the 3D effect around the Border. +
                +
                +
                Declaration
                +
                + 
                public bool Effect3D { get; set; }
                +
                +
                Property Value
                + + + + + + + + + + + + + +
                TypeDescription
                System.Boolean
                + +

                Effect3DBrush

                +
                +Gets or sets the color for the Border +
                +
                +
                Declaration
                +
                + 
                public Attribute? Effect3DBrush { get; set; }
                +
                +
                Property Value
                + + + + + + + + + + + + + +
                TypeDescription
                System.Nullable<Attribute>
                + +

                Effect3DOffset

                +
                +Get or sets the offset start position for the Effect3D +
                +
                +
                Declaration
                +
                + 
                public Point Effect3DOffset { get; set; }
                +
                +
                Property Value
                + + + + + + + + + + + + + +
                TypeDescription
                Point
                + +

                Padding

                +
                +Gets or sets a Thickness value that describes the amount of space between a +Border and its child element. +
                +
                +
                Declaration
                +
                + 
                public Thickness Padding { get; set; }
                +
                +
                Property Value
                + + + + + + + + + + + + + +
                TypeDescription
                Thickness
                + +

                Parent

                +
                +Gets the parent Child parent if any. +
                +
                +
                Declaration
                +
                + 
                public View Parent { get; }
                +
                +
                Property Value
                + + + + + + + + + + + + + +
                TypeDescription
                View
                +

                Methods +

                + +

                DrawContent(View, Boolean)

                +
                +Drawn the BorderThickness more the Padding +more the BorderStyle and the Effect3D. +
                +
                +
                Declaration
                +
                + 
                public void DrawContent(View view = null, bool fill = true)
                +
                +
                Parameters
                + + + + + + + + + + + + + + + + + + + + +
                TypeNameDescription
                ViewviewThe view to draw.
                System.BooleanfillIf it will clear or not the content area.
                + +

                DrawFullContent()

                +
                +Same as DrawContent(View, Boolean) but drawing full frames for all borders. +
                +
                +
                Declaration
                +
                + 
                public void DrawFullContent()
                +
                + +

                DrawTitle(View, Rect)

                +
                +Drawn the view text from a View. +
                +
                +
                Declaration
                +
                + 
                public void DrawTitle(View view, Rect rect)
                +
                +
                Parameters
                + + + + + + + + + + + + + + + + + + + + +
                TypeNameDescription
                Viewview
                Rectrect
                + +

                GetSumThickness()

                +
                +Calculate the sum of the Padding and the BorderThickness +
                +
                +
                Declaration
                +
                + 
                public Thickness GetSumThickness()
                +
                +
                Returns
                + + + + + + + + + + + + + +
                TypeDescription
                ThicknessThe total of the Border Thickness
                + +

                OnBorderChanged()

                +
                +Invoke the BorderChanged event. +
                +
                +
                Declaration
                +
                + 
                public virtual void OnBorderChanged()
                +
                +

                Events +

                +

                BorderChanged

                +
                +Event to be invoked when any border property change. +
                +
                +
                Declaration
                +
                + 
                public event Action<Border> BorderChanged
                +
                +
                Event Type
                + + + + + + + + + + + + + +
                TypeDescription
                System.Action<Border>
                +
                +
                + + +
                +
                + + +
                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.BorderStyle.html b/docs/api/Terminal.Gui/Terminal.Gui.BorderStyle.html new file mode 100644 index 0000000000..b141fe2af1 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.BorderStyle.html @@ -0,0 +1,164 @@ + + + + + + + + Enum BorderStyle + + + + + + + + + + + + + + + + +
                +
                + + + +
                + +
                +
                +
                + +
                +
                Search Results for
                +
                +

                +
                +
                  +
                  +
                  +
                  + +
                  + +
                  +
                  +
                  +
                  +
                  +
                  +
                  + + +

                  Enum BorderStyle +

                  +
                  +Specifies the border style for a View and to be used by the Border class. +
                  +
                  +
                  Namespace: Terminal.Gui
                  +
                  Assembly: Terminal.Gui.dll
                  +
                  Syntax
                  +
                  + 
                  public enum BorderStyle
                  +
                  +

                  Fields +

                  + + + + + + + + + + + + + + + + + + + + + + + + + +
                  NameDescription
                  Double +The border is drawn with a double line limits. +
                  None +No border is drawn. +
                  Rounded +The border is drawn with a single line and rounded corners limits. +
                  Single +The border is drawn with a single line limits. +
                  +
                  +
                  + + +
                  +
                  + + +
                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Button.html b/docs/api/Terminal.Gui/Terminal.Gui.Button.html new file mode 100644 index 0000000000..d7e24c4252 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Button.html @@ -0,0 +1,1063 @@ + + + + + + + + Class Button + + + + + + + + + + + + + + + + +
                  +
                  + + + +
                  + +
                  +
                  +
                  + +
                  +
                  Search Results for
                  +
                  +

                  +
                  +
                    +
                    +
                    +
                    + +
                    + +
                    +
                    +
                    +
                    +
                    +
                    +
                    + + +

                    Class Button +

                    +
                    +Button is a View that provides an item that invokes an System.Action when activated by the user. +
                    +
                    +
                    +
                    Inheritance
                    +
                    System.Object
                    +
                    Responder
                    +
                    View
                    +
                    Button
                    +
                    +
                    +
                    Implements
                    +
                    System.IDisposable
                    +
                    System.ComponentModel.ISupportInitializeNotification
                    +
                    System.ComponentModel.ISupportInitialize
                    +
                    +
                    +
                    Inherited Members
                    + + + + + + + + + + + + + + + +
                    + View.Data +
                    + + + + + + +
                    + View.Id +
                    + + + + + + +
                    + View.X +
                    +
                    + View.Y +
                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                    + View.Text +
                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                    + System.Object.Equals(System.Object) +
                    +
                    + System.Object.Equals(System.Object, System.Object) +
                    +
                    + System.Object.GetHashCode() +
                    +
                    + System.Object.GetType() +
                    +
                    + System.Object.MemberwiseClone() +
                    +
                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                    +
                    +
                    Namespace: Terminal.Gui
                    +
                    Assembly: Terminal.Gui.dll
                    +
                    Syntax
                    +
                    + 
                    public class Button : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                    +
                    +
                    Remarks
                    +
                    +

                    + Provides a button showing text invokes an System.Action when clicked on with a mouse + or when the user presses SPACE, ENTER, or hotkey. The hotkey is the first letter or digit following the first underscore ('_') + in the button text. +

                    +

                    + Use HotKeySpecifier to change the hotkey specifier from the default of ('_'). +

                    +

                    + If no hotkey specifier is found, the first uppercase letter encountered will be used as the hotkey. +

                    +

                    + When the button is configured as the default (IsDefault) and the user presses + the ENTER key, if no other View processes the KeyEvent, the Button's +System.Action will be invoked. +

                    +
                    +

                    Constructors +

                    + +

                    Button()

                    +
                    +Initializes a new instance of Button using Computed layout. +
                    +
                    +
                    Declaration
                    +
                    + 
                    public Button()
                    +
                    +
                    Remarks
                    +
                    +The width of the Button is computed based on the +text length. The height will always be 1. +
                    + +

                    Button(ustring, Boolean)

                    +
                    +Initializes a new instance of Button using Computed layout. +
                    +
                    +
                    Declaration
                    +
                    + 
                    public Button(ustring text, bool is_default = false)
                    +
                    +
                    Parameters
                    + + + + + + + + + + + + + + + + + + + + +
                    TypeNameDescription
                    NStack.ustringtextThe button's text
                    System.Booleanis_default +If true, a special decoration is used, and the user pressing the enter key +in a Dialog will implicitly activate this button. +
                    +
                    Remarks
                    +
                    +The width of the Button is computed based on the +text length. The height will always be 1. +
                    + +

                    Button(Int32, Int32, ustring)

                    +
                    +Initializes a new instance of Button using Absolute layout, based on the given text +
                    +
                    +
                    Declaration
                    +
                    + 
                    public Button(int x, int y, ustring text)
                    +
                    +
                    Parameters
                    + + + + + + + + + + + + + + + + + + + + + + + + + +
                    TypeNameDescription
                    System.Int32xX position where the button will be shown.
                    System.Int32yY position where the button will be shown.
                    NStack.ustringtextThe button's text
                    +
                    Remarks
                    +
                    +The width of the Button is computed based on the +text length. The height will always be 1. +
                    + +

                    Button(Int32, Int32, ustring, Boolean)

                    +
                    +Initializes a new instance of Button using Absolute layout, based on the given text. +
                    +
                    +
                    Declaration
                    +
                    + 
                    public Button(int x, int y, ustring text, bool is_default)
                    +
                    +
                    Parameters
                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                    TypeNameDescription
                    System.Int32xX position where the button will be shown.
                    System.Int32yY position where the button will be shown.
                    NStack.ustringtextThe button's text
                    System.Booleanis_default +If true, a special decoration is used, and the user pressing the enter key +in a Dialog will implicitly activate this button. +
                    +
                    Remarks
                    +
                    +The width of the Button is computed based on the +text length. The height will always be 1. +
                    +

                    Properties +

                    + +

                    HotKey

                    +
                    +
                    +
                    Declaration
                    +
                    + 
                    public override Key HotKey { get; set; }
                    +
                    +
                    Property Value
                    + + + + + + + + + + + + + +
                    TypeDescription
                    Key
                    +
                    Overrides
                    + + +

                    IsDefault

                    +
                    +Gets or sets whether the Button is the default action to activate in a dialog. +
                    +
                    +
                    Declaration
                    +
                    + 
                    public bool IsDefault { get; set; }
                    +
                    +
                    Property Value
                    + + + + + + + + + + + + + +
                    TypeDescription
                    System.Booleantrue if is default; otherwise, false.
                    +

                    Methods +

                    + +

                    MouseEvent(MouseEvent)

                    +
                    +
                    +
                    Declaration
                    +
                    + 
                    public override bool MouseEvent(MouseEvent me)
                    +
                    +
                    Parameters
                    + + + + + + + + + + + + + + + +
                    TypeNameDescription
                    MouseEventme
                    +
                    Returns
                    + + + + + + + + + + + + + +
                    TypeDescription
                    System.Boolean
                    +
                    Overrides
                    + + +

                    OnClicked()

                    +
                    +Virtual method to invoke the Clicked event. +
                    +
                    +
                    Declaration
                    +
                    + 
                    public virtual void OnClicked()
                    +
                    + +

                    OnEnter(View)

                    +
                    +
                    +
                    Declaration
                    +
                    + 
                    public override bool OnEnter(View view)
                    +
                    +
                    Parameters
                    + + + + + + + + + + + + + + + +
                    TypeNameDescription
                    Viewview
                    +
                    Returns
                    + + + + + + + + + + + + + +
                    TypeDescription
                    System.Boolean
                    +
                    Overrides
                    + + +

                    PositionCursor()

                    +
                    +
                    +
                    Declaration
                    +
                    + 
                    public override void PositionCursor()
                    +
                    +
                    Overrides
                    + + +

                    ProcessColdKey(KeyEvent)

                    +
                    +
                    +
                    Declaration
                    +
                    + 
                    public override bool ProcessColdKey(KeyEvent kb)
                    +
                    +
                    Parameters
                    + + + + + + + + + + + + + + + +
                    TypeNameDescription
                    KeyEventkb
                    +
                    Returns
                    + + + + + + + + + + + + + +
                    TypeDescription
                    System.Boolean
                    +
                    Overrides
                    + + +

                    ProcessHotKey(KeyEvent)

                    +
                    +
                    +
                    Declaration
                    +
                    + 
                    public override bool ProcessHotKey(KeyEvent kb)
                    +
                    +
                    Parameters
                    + + + + + + + + + + + + + + + +
                    TypeNameDescription
                    KeyEventkb
                    +
                    Returns
                    + + + + + + + + + + + + + +
                    TypeDescription
                    System.Boolean
                    +
                    Overrides
                    + + +

                    ProcessKey(KeyEvent)

                    +
                    +
                    +
                    Declaration
                    +
                    + 
                    public override bool ProcessKey(KeyEvent kb)
                    +
                    +
                    Parameters
                    + + + + + + + + + + + + + + + +
                    TypeNameDescription
                    KeyEventkb
                    +
                    Returns
                    + + + + + + + + + + + + + +
                    TypeDescription
                    System.Boolean
                    +
                    Overrides
                    + + +

                    UpdateTextFormatterText()

                    +
                    +
                    +
                    Declaration
                    +
                    + 
                    protected override void UpdateTextFormatterText()
                    +
                    +
                    Overrides
                    + +

                    Events +

                    +

                    Clicked

                    +
                    +Clicked System.Action, raised when the user clicks the primary mouse button within the Bounds of this View +or if the user presses the action key while this view is focused. (TODO: IsDefault) +
                    +
                    +
                    Declaration
                    +
                    + 
                    public event Action Clicked
                    +
                    +
                    Event Type
                    + + + + + + + + + + + + + +
                    TypeDescription
                    System.Action
                    +
                    Remarks
                    +
                    +Client code can hook up to this event, it is +raised when the button is activated either with +the mouse or the keyboard. +
                    +

                    Implements

                    +
                    + System.IDisposable +
                    +
                    + System.ComponentModel.ISupportInitializeNotification +
                    +
                    + System.ComponentModel.ISupportInitialize +
                    +
                    +
                    + + +
                    +
                    + + +
                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.CheckBox.html b/docs/api/Terminal.Gui/Terminal.Gui.CheckBox.html new file mode 100644 index 0000000000..1558981657 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.CheckBox.html @@ -0,0 +1,983 @@ + + + + + + + + Class CheckBox + + + + + + + + + + + + + + + + +
                    +
                    + + + +
                    + +
                    +
                    +
                    + +
                    +
                    Search Results for
                    +
                    +

                    +
                    +
                      +
                      +
                      +
                      + +
                      + +
                      +
                      +
                      +
                      +
                      +
                      +
                      + + +

                      Class CheckBox +

                      +
                      +The CheckBox View shows an on/off toggle that the user can set +
                      +
                      +
                      +
                      Inheritance
                      +
                      System.Object
                      +
                      Responder
                      +
                      View
                      +
                      CheckBox
                      +
                      +
                      +
                      Implements
                      +
                      System.IDisposable
                      +
                      System.ComponentModel.ISupportInitializeNotification
                      +
                      System.ComponentModel.ISupportInitialize
                      +
                      +
                      +
                      Inherited Members
                      + + + + + + + + + + + + + + + + +
                      + View.Data +
                      + + + + + + +
                      + View.Id +
                      + + + + + + +
                      + View.X +
                      +
                      + View.Y +
                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                      + View.Text +
                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                      + System.Object.Equals(System.Object) +
                      +
                      + System.Object.Equals(System.Object, System.Object) +
                      +
                      + System.Object.GetHashCode() +
                      +
                      + System.Object.GetType() +
                      +
                      + System.Object.MemberwiseClone() +
                      +
                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                      +
                      +
                      Namespace: Terminal.Gui
                      +
                      Assembly: Terminal.Gui.dll
                      +
                      Syntax
                      +
                      + 
                      public class CheckBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                      +
                      +

                      Constructors +

                      + +

                      CheckBox()

                      +
                      +Initializes a new instance of CheckBox based on the given text, using Computed layout. +
                      +
                      +
                      Declaration
                      +
                      + 
                      public CheckBox()
                      +
                      + +

                      CheckBox(ustring, Boolean)

                      +
                      +Initializes a new instance of CheckBox based on the given text, using Computed layout. +
                      +
                      +
                      Declaration
                      +
                      + 
                      public CheckBox(ustring s, bool is_checked = false)
                      +
                      +
                      Parameters
                      + + + + + + + + + + + + + + + + + + + + +
                      TypeNameDescription
                      NStack.ustringsS.
                      System.Booleanis_checkedIf set to true is checked.
                      + +

                      CheckBox(Int32, Int32, ustring)

                      +
                      +Initializes a new instance of CheckBox using Absolute layout. +
                      +
                      +
                      Declaration
                      +
                      + 
                      public CheckBox(int x, int y, ustring s)
                      +
                      +
                      Parameters
                      + + + + + + + + + + + + + + + + + + + + + + + + + +
                      TypeNameDescription
                      System.Int32x
                      System.Int32y
                      NStack.ustrings
                      +
                      Remarks
                      +
                      +The size of CheckBox is computed based on the +text length. This CheckBox is not toggled. +
                      + +

                      CheckBox(Int32, Int32, ustring, Boolean)

                      +
                      +Initializes a new instance of CheckBox using Absolute layout. +
                      +
                      +
                      Declaration
                      +
                      + 
                      public CheckBox(int x, int y, ustring s, bool is_checked)
                      +
                      +
                      Parameters
                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                      TypeNameDescription
                      System.Int32x
                      System.Int32y
                      NStack.ustrings
                      System.Booleanis_checked
                      +
                      Remarks
                      +
                      +The size of CheckBox is computed based on the +text length. +
                      +

                      Properties +

                      + +

                      Checked

                      +
                      +The state of the CheckBox +
                      +
                      +
                      Declaration
                      +
                      + 
                      public bool Checked { get; set; }
                      +
                      +
                      Property Value
                      + + + + + + + + + + + + + +
                      TypeDescription
                      System.Boolean
                      +

                      Methods +

                      + +

                      MouseEvent(MouseEvent)

                      +
                      +
                      +
                      Declaration
                      +
                      + 
                      public override bool MouseEvent(MouseEvent me)
                      +
                      +
                      Parameters
                      + + + + + + + + + + + + + + + +
                      TypeNameDescription
                      MouseEventme
                      +
                      Returns
                      + + + + + + + + + + + + + +
                      TypeDescription
                      System.Boolean
                      +
                      Overrides
                      + + +

                      OnEnter(View)

                      +
                      +
                      +
                      Declaration
                      +
                      + 
                      public override bool OnEnter(View view)
                      +
                      +
                      Parameters
                      + + + + + + + + + + + + + + + +
                      TypeNameDescription
                      Viewview
                      +
                      Returns
                      + + + + + + + + + + + + + +
                      TypeDescription
                      System.Boolean
                      +
                      Overrides
                      + + +

                      OnToggled(Boolean)

                      +
                      +Called when the Checked property changes. Invokes the Toggled event. +
                      +
                      +
                      Declaration
                      +
                      + 
                      public virtual void OnToggled(bool previousChecked)
                      +
                      +
                      Parameters
                      + + + + + + + + + + + + + + + +
                      TypeNameDescription
                      System.BooleanpreviousChecked
                      + +

                      PositionCursor()

                      +
                      +
                      +
                      Declaration
                      +
                      + 
                      public override void PositionCursor()
                      +
                      +
                      Overrides
                      + + +

                      ProcessHotKey(KeyEvent)

                      +
                      +
                      +
                      Declaration
                      +
                      + 
                      public override bool ProcessHotKey(KeyEvent kb)
                      +
                      +
                      Parameters
                      + + + + + + + + + + + + + + + +
                      TypeNameDescription
                      KeyEventkb
                      +
                      Returns
                      + + + + + + + + + + + + + +
                      TypeDescription
                      System.Boolean
                      +
                      Overrides
                      + + +

                      ProcessKey(KeyEvent)

                      +
                      +
                      +
                      Declaration
                      +
                      + 
                      public override bool ProcessKey(KeyEvent kb)
                      +
                      +
                      Parameters
                      + + + + + + + + + + + + + + + +
                      TypeNameDescription
                      KeyEventkb
                      +
                      Returns
                      + + + + + + + + + + + + + +
                      TypeDescription
                      System.Boolean
                      +
                      Overrides
                      + + +

                      UpdateTextFormatterText()

                      +
                      +
                      +
                      Declaration
                      +
                      + 
                      protected override void UpdateTextFormatterText()
                      +
                      +
                      Overrides
                      + +

                      Events +

                      +

                      Toggled

                      +
                      +Toggled event, raised when the CheckBox is toggled. +
                      +
                      +
                      Declaration
                      +
                      + 
                      public event Action<bool> Toggled
                      +
                      +
                      Event Type
                      + + + + + + + + + + + + + +
                      TypeDescription
                      System.Action<System.Boolean>
                      +
                      Remarks
                      +
                      +Client code can hook up to this event, it is +raised when the CheckBox is activated either with +the mouse or the keyboard. The passed bool contains the previous state. +
                      +

                      Implements

                      +
                      + System.IDisposable +
                      +
                      + System.ComponentModel.ISupportInitializeNotification +
                      +
                      + System.ComponentModel.ISupportInitialize +
                      +
                      +
                      + + +
                      +
                      + + +
                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Clipboard.html b/docs/api/Terminal.Gui/Terminal.Gui.Clipboard.html new file mode 100644 index 0000000000..21e339e322 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Clipboard.html @@ -0,0 +1,295 @@ + + + + + + + + Class Clipboard + + + + + + + + + + + + + + + + +
                      +
                      + + + +
                      + +
                      +
                      +
                      + +
                      +
                      Search Results for
                      +
                      +

                      +
                      +
                        +
                        +
                        +
                        + +
                        + +
                        +
                        +
                        +
                        +
                        +
                        +
                        + + +

                        Class Clipboard +

                        +
                        +Provides cut, copy, and paste support for the clipboard with OS interaction. +
                        +
                        +
                        +
                        Inheritance
                        +
                        System.Object
                        +
                        Clipboard
                        +
                        +
                        +
                        Inherited Members
                        +
                        + System.Object.Equals(System.Object) +
                        +
                        + System.Object.Equals(System.Object, System.Object) +
                        +
                        + System.Object.GetHashCode() +
                        +
                        + System.Object.GetType() +
                        +
                        + System.Object.MemberwiseClone() +
                        +
                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                        +
                        + System.Object.ToString() +
                        +
                        +
                        Namespace: Terminal.Gui
                        +
                        Assembly: Terminal.Gui.dll
                        +
                        Syntax
                        +
                        + 
                        public static class Clipboard
                        +
                        +

                        Properties +

                        + +

                        Contents

                        +
                        +Get or sets the operation system clipboard, otherwise the contents field. +
                        +
                        +
                        Declaration
                        +
                        + 
                        public static ustring Contents { get; set; }
                        +
                        +
                        Property Value
                        + + + + + + + + + + + + + +
                        TypeDescription
                        NStack.ustring
                        + +

                        IsSupported

                        +
                        +Returns true if the environmental dependencies are in place to interact with the OS clipboard. +
                        +
                        +
                        Declaration
                        +
                        + 
                        public static bool IsSupported { get; }
                        +
                        +
                        Property Value
                        + + + + + + + + + + + + + +
                        TypeDescription
                        System.Boolean
                        +

                        Methods +

                        + +

                        TryGetClipboardData(out String)

                        +
                        +Gets the operation system clipboard if possible. +
                        +
                        +
                        Declaration
                        +
                        + 
                        public static bool TryGetClipboardData(out string result)
                        +
                        +
                        Parameters
                        + + + + + + + + + + + + + + + +
                        TypeNameDescription
                        System.StringresultClipboard contents read
                        +
                        Returns
                        + + + + + + + + + + + + + +
                        TypeDescription
                        System.Booleantrue if it was possible to read the OS clipboard.
                        + +

                        TrySetClipboardData(String)

                        +
                        +Sets the operation system clipboard if possible. +
                        +
                        +
                        Declaration
                        +
                        + 
                        public static bool TrySetClipboardData(string text)
                        +
                        +
                        Parameters
                        + + + + + + + + + + + + + + + +
                        TypeNameDescription
                        System.Stringtext
                        +
                        Returns
                        + + + + + + + + + + + + + +
                        TypeDescription
                        System.BooleanTrue if the clipboard content was set successfully.
                        +
                        +
                        + + +
                        +
                        + + +
                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ClipboardBase.html b/docs/api/Terminal.Gui/Terminal.Gui.ClipboardBase.html new file mode 100644 index 0000000000..5558816a2e --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ClipboardBase.html @@ -0,0 +1,412 @@ + + + + + + + + Class ClipboardBase + + + + + + + + + + + + + + + + +
                        +
                        + + + +
                        + +
                        +
                        +
                        + +
                        +
                        Search Results for
                        +
                        +

                        +
                        +
                          +
                          +
                          +
                          + +
                          + +
                          +
                          +
                          +
                          +
                          +
                          +
                          + + +

                          Class ClipboardBase +

                          +
                          +Shared abstract class to enforce rules from the implementation of the IClipboard interface. +
                          +
                          +
                          +
                          Inheritance
                          +
                          System.Object
                          +
                          ClipboardBase
                          +
                          +
                          +
                          Implements
                          + +
                          +
                          +
                          Inherited Members
                          +
                          + System.Object.Equals(System.Object) +
                          +
                          + System.Object.Equals(System.Object, System.Object) +
                          +
                          + System.Object.GetHashCode() +
                          +
                          + System.Object.GetType() +
                          +
                          + System.Object.MemberwiseClone() +
                          +
                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                          +
                          + System.Object.ToString() +
                          +
                          +
                          Namespace: Terminal.Gui
                          +
                          Assembly: Terminal.Gui.dll
                          +
                          Syntax
                          +
                          + 
                          public abstract class ClipboardBase : IClipboard
                          +
                          +

                          Properties +

                          + +

                          IsSupported

                          +
                          +Returns true if the environmental dependencies are in place to interact with the OS clipboard +
                          +
                          +
                          Declaration
                          +
                          + 
                          public abstract bool IsSupported { get; }
                          +
                          +
                          Property Value
                          + + + + + + + + + + + + + +
                          TypeDescription
                          System.Boolean
                          +

                          Methods +

                          + +

                          GetClipboardData()

                          +
                          +Get the operation system clipboard. +
                          +
                          +
                          Declaration
                          +
                          + 
                          public string GetClipboardData()
                          +
                          +
                          Returns
                          + + + + + + + + + + + + + +
                          TypeDescription
                          System.String
                          +
                          Exceptions
                          + + + + + + + + + + + + + +
                          TypeCondition
                          System.NotSupportedExceptionThrown if it was not possible to read the clipboard contents
                          + +

                          GetClipboardDataImpl()

                          +
                          +Get the operation system clipboard. +
                          +
                          +
                          Declaration
                          +
                          + 
                          protected abstract string GetClipboardDataImpl()
                          +
                          +
                          Returns
                          + + + + + + + + + + + + + +
                          TypeDescription
                          System.String
                          + +

                          SetClipboardData(String)

                          +
                          +Sets the operation system clipboard. +
                          +
                          +
                          Declaration
                          +
                          + 
                          public void SetClipboardData(string text)
                          +
                          +
                          Parameters
                          + + + + + + + + + + + + + + + +
                          TypeNameDescription
                          System.Stringtext
                          +
                          Exceptions
                          + + + + + + + + + + + + + +
                          TypeCondition
                          System.NotSupportedExceptionThrown if it was not possible to set the clipboard contents
                          + +

                          SetClipboardDataImpl(String)

                          +
                          +Sets the operation system clipboard. +
                          +
                          +
                          Declaration
                          +
                          + 
                          protected abstract void SetClipboardDataImpl(string text)
                          +
                          +
                          Parameters
                          + + + + + + + + + + + + + + + +
                          TypeNameDescription
                          System.Stringtext
                          + +

                          TryGetClipboardData(out String)

                          +
                          +Gets the operation system clipboard if possible. +
                          +
                          +
                          Declaration
                          +
                          + 
                          public bool TryGetClipboardData(out string result)
                          +
                          +
                          Parameters
                          + + + + + + + + + + + + + + + +
                          TypeNameDescription
                          System.StringresultClipboard contents read
                          +
                          Returns
                          + + + + + + + + + + + + + +
                          TypeDescription
                          System.Booleantrue if it was possible to read the OS clipboard.
                          + +

                          TrySetClipboardData(String)

                          +
                          +Sets the operation system clipboard if possible. +
                          +
                          +
                          Declaration
                          +
                          + 
                          public bool TrySetClipboardData(string text)
                          +
                          +
                          Parameters
                          + + + + + + + + + + + + + + + +
                          TypeNameDescription
                          System.Stringtext
                          +
                          Returns
                          + + + + + + + + + + + + + +
                          TypeDescription
                          System.BooleanTrue if the clipboard content was set successfully
                          +

                          Implements

                          + +
                          +
                          + + +
                          +
                          + + +
                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Color.html b/docs/api/Terminal.Gui/Terminal.Gui.Color.html new file mode 100644 index 0000000000..8258ddf007 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Color.html @@ -0,0 +1,236 @@ + + + + + + + + Enum Color + + + + + + + + + + + + + + + + +
                          +
                          + + + +
                          + +
                          +
                          +
                          + +
                          +
                          Search Results for
                          +
                          +

                          +
                          +
                            +
                            +
                            +
                            + +
                            + +
                            +
                            +
                            +
                            +
                            +
                            +
                            + + +

                            Enum Color +

                            +
                            +Basic colors that can be used to set the foreground and background colors in console applications. +
                            +
                            +
                            Namespace: Terminal.Gui
                            +
                            Assembly: Terminal.Gui.dll
                            +
                            Syntax
                            +
                            + 
                            public enum Color
                            +
                            +

                            Fields +

                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                            NameDescription
                            Black +The black color. +
                            Blue +The blue color. +
                            BrightBlue +The bright bBlue color. +
                            BrightCyan +The bright cyan color. +
                            BrightGreen +The bright green color. +
                            BrightMagenta +The bright magenta color. +
                            BrightRed +The bright red color. +
                            BrightYellow +The bright yellow color. +
                            Brown +The brown color. +
                            Cyan +The cyan color. +
                            DarkGray +The dark gray color. +
                            Gray +The gray color. +
                            Green +The green color. +
                            Magenta +The magenta color. +
                            Red +The red color. +
                            White +The White color. +
                            +
                            +
                            + + +
                            +
                            + + +
                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ColorPicker.html b/docs/api/Terminal.Gui/Terminal.Gui.ColorPicker.html new file mode 100644 index 0000000000..b564f1d144 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ColorPicker.html @@ -0,0 +1,982 @@ + + + + + + + + Class ColorPicker + + + + + + + + + + + + + + + + +
                            +
                            + + + +
                            + +
                            +
                            +
                            + +
                            +
                            Search Results for
                            +
                            +

                            +
                            +
                              +
                              +
                              +
                              + +
                              + +
                              +
                              +
                              +
                              +
                              +
                              +
                              + + +

                              Class ColorPicker +

                              +
                              +The ColorPicker View Color picker. +
                              +
                              +
                              +
                              Inheritance
                              +
                              System.Object
                              +
                              Responder
                              +
                              View
                              +
                              ColorPicker
                              +
                              +
                              +
                              Implements
                              +
                              System.IDisposable
                              +
                              System.ComponentModel.ISupportInitializeNotification
                              +
                              System.ComponentModel.ISupportInitialize
                              +
                              +
                              +
                              Inherited Members
                              + + + + + + + + + + + + + + + + +
                              + View.Data +
                              + + + + + + +
                              + View.Id +
                              + + + + + + +
                              + View.X +
                              +
                              + View.Y +
                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                              + View.Text +
                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                              + System.Object.Equals(System.Object) +
                              +
                              + System.Object.Equals(System.Object, System.Object) +
                              +
                              + System.Object.GetHashCode() +
                              +
                              + System.Object.GetType() +
                              +
                              + System.Object.MemberwiseClone() +
                              +
                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                              +
                              +
                              Namespace: Terminal.Gui
                              +
                              Assembly: Terminal.Gui.dll
                              +
                              Syntax
                              +
                              + 
                              public class ColorPicker : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                              +
                              +

                              Constructors +

                              + +

                              ColorPicker()

                              +
                              +Initializes a new instance of ColorPicker. +
                              +
                              +
                              Declaration
                              +
                              + 
                              public ColorPicker()
                              +
                              + +

                              ColorPicker(ustring)

                              +
                              +Initializes a new instance of ColorPicker. +
                              +
                              +
                              Declaration
                              +
                              + 
                              public ColorPicker(ustring title)
                              +
                              +
                              Parameters
                              + + + + + + + + + + + + + + + +
                              TypeNameDescription
                              NStack.ustringtitleTitle.
                              + +

                              ColorPicker(Int32, Int32, ustring)

                              +
                              +Initializes a new instance of ColorPicker. +
                              +
                              +
                              Declaration
                              +
                              + 
                              public ColorPicker(int x, int y, ustring title)
                              +
                              +
                              Parameters
                              + + + + + + + + + + + + + + + + + + + + + + + + + +
                              TypeNameDescription
                              System.Int32xX location.
                              System.Int32yY location.
                              NStack.ustringtitleTitle
                              + +

                              ColorPicker(Point, ustring)

                              +
                              +Initializes a new instance of ColorPicker. +
                              +
                              +
                              Declaration
                              +
                              + 
                              public ColorPicker(Point point, ustring title)
                              +
                              +
                              Parameters
                              + + + + + + + + + + + + + + + + + + + + +
                              TypeNameDescription
                              PointpointLocation point.
                              NStack.ustringtitleTitle.
                              +

                              Properties +

                              + +

                              Cursor

                              +
                              +Cursor for the selected color. +
                              +
                              +
                              Declaration
                              +
                              + 
                              public Point Cursor { get; set; }
                              +
                              +
                              Property Value
                              + + + + + + + + + + + + + +
                              TypeDescription
                              Point
                              + +

                              SelectedColor

                              +
                              +Selected color. +
                              +
                              +
                              Declaration
                              +
                              + 
                              public Color SelectedColor { get; set; }
                              +
                              +
                              Property Value
                              + + + + + + + + + + + + + +
                              TypeDescription
                              Color
                              +

                              Methods +

                              + +

                              MouseEvent(MouseEvent)

                              +
                              +
                              +
                              Declaration
                              +
                              + 
                              public override bool MouseEvent(MouseEvent me)
                              +
                              +
                              Parameters
                              + + + + + + + + + + + + + + + +
                              TypeNameDescription
                              MouseEventme
                              +
                              Returns
                              + + + + + + + + + + + + + +
                              TypeDescription
                              System.Boolean
                              +
                              Overrides
                              + + +

                              MoveDown()

                              +
                              +Moves the selected item index to the next row. +
                              +
                              +
                              Declaration
                              +
                              + 
                              public virtual bool MoveDown()
                              +
                              +
                              Returns
                              + + + + + + + + + + + + + +
                              TypeDescription
                              System.Boolean
                              + +

                              MoveLeft()

                              +
                              +Moves the selected item index to the previous column. +
                              +
                              +
                              Declaration
                              +
                              + 
                              public virtual bool MoveLeft()
                              +
                              +
                              Returns
                              + + + + + + + + + + + + + +
                              TypeDescription
                              System.Boolean
                              + +

                              MoveRight()

                              +
                              +Moves the selected item index to the next column. +
                              +
                              +
                              Declaration
                              +
                              + 
                              public virtual bool MoveRight()
                              +
                              +
                              Returns
                              + + + + + + + + + + + + + +
                              TypeDescription
                              System.Boolean
                              + +

                              MoveUp()

                              +
                              +Moves the selected item index to the previous row. +
                              +
                              +
                              Declaration
                              +
                              + 
                              public virtual bool MoveUp()
                              +
                              +
                              Returns
                              + + + + + + + + + + + + + +
                              TypeDescription
                              System.Boolean
                              + +

                              ProcessKey(KeyEvent)

                              +
                              +
                              +
                              Declaration
                              +
                              + 
                              public override bool ProcessKey(KeyEvent kb)
                              +
                              +
                              Parameters
                              + + + + + + + + + + + + + + + +
                              TypeNameDescription
                              KeyEventkb
                              +
                              Returns
                              + + + + + + + + + + + + + +
                              TypeDescription
                              System.Boolean
                              +
                              Overrides
                              + + +

                              Redraw(Rect)

                              +
                              +
                              +
                              Declaration
                              +
                              + 
                              public override void Redraw(Rect bounds)
                              +
                              +
                              Parameters
                              + + + + + + + + + + + + + + + +
                              TypeNameDescription
                              Rectbounds
                              +
                              Overrides
                              + +

                              Events +

                              +

                              ColorChanged

                              +
                              +Fired when a color is picked. +
                              +
                              +
                              Declaration
                              +
                              + 
                              public event Action ColorChanged
                              +
                              +
                              Event Type
                              + + + + + + + + + + + + + +
                              TypeDescription
                              System.Action
                              +

                              Implements

                              +
                              + System.IDisposable +
                              +
                              + System.ComponentModel.ISupportInitializeNotification +
                              +
                              + System.ComponentModel.ISupportInitialize +
                              +
                              +
                              + + +
                              +
                              + + +
                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ColorScheme.html b/docs/api/Terminal.Gui/Terminal.Gui.ColorScheme.html new file mode 100644 index 0000000000..ed63d4a819 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ColorScheme.html @@ -0,0 +1,499 @@ + + + + + + + + Class ColorScheme + + + + + + + + + + + + + + + + +
                              +
                              + + + +
                              + +
                              +
                              +
                              + +
                              +
                              Search Results for
                              +
                              +

                              +
                              +
                                +
                                +
                                +
                                + +
                                + +
                                +
                                +
                                +
                                +
                                +
                                +
                                + + +

                                Class ColorScheme +

                                +
                                +Color scheme definitions, they cover some common scenarios and are used +typically in containers such as Window and FrameView to set the scheme that is used by all the +views contained inside. +
                                +
                                +
                                +
                                Inheritance
                                +
                                System.Object
                                +
                                ColorScheme
                                +
                                +
                                +
                                Implements
                                +
                                System.IEquatable<ColorScheme>
                                +
                                +
                                +
                                Inherited Members
                                +
                                + System.Object.Equals(System.Object, System.Object) +
                                +
                                + System.Object.GetType() +
                                +
                                + System.Object.MemberwiseClone() +
                                +
                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                +
                                + System.Object.ToString() +
                                +
                                +
                                Namespace: Terminal.Gui
                                +
                                Assembly: Terminal.Gui.dll
                                +
                                Syntax
                                +
                                + 
                                public class ColorScheme : IEquatable<ColorScheme>
                                +
                                +

                                Properties +

                                + +

                                Disabled

                                +
                                +The default color for text, when the view is disabled. +
                                +
                                +
                                Declaration
                                +
                                + 
                                public Attribute Disabled { get; set; }
                                +
                                +
                                Property Value
                                + + + + + + + + + + + + + +
                                TypeDescription
                                Attribute
                                + +

                                Focus

                                +
                                +The color for text when the view has the focus. +
                                +
                                +
                                Declaration
                                +
                                + 
                                public Attribute Focus { get; set; }
                                +
                                +
                                Property Value
                                + + + + + + + + + + + + + +
                                TypeDescription
                                Attribute
                                + +

                                HotFocus

                                +
                                +The color for the hotkey when the view is focused. +
                                +
                                +
                                Declaration
                                +
                                + 
                                public Attribute HotFocus { get; set; }
                                +
                                +
                                Property Value
                                + + + + + + + + + + + + + +
                                TypeDescription
                                Attribute
                                + +

                                HotNormal

                                +
                                +The color for the hotkey when a view is not focused +
                                +
                                +
                                Declaration
                                +
                                + 
                                public Attribute HotNormal { get; set; }
                                +
                                +
                                Property Value
                                + + + + + + + + + + + + + +
                                TypeDescription
                                Attribute
                                + +

                                Normal

                                +
                                +The default color for text, when the view is not focused. +
                                +
                                +
                                Declaration
                                +
                                + 
                                public Attribute Normal { get; set; }
                                +
                                +
                                Property Value
                                + + + + + + + + + + + + + +
                                TypeDescription
                                Attribute
                                +

                                Methods +

                                + +

                                Equals(Object)

                                +
                                +Compares two ColorScheme objects for equality. +
                                +
                                +
                                Declaration
                                +
                                + 
                                public override bool Equals(object obj)
                                +
                                +
                                Parameters
                                + + + + + + + + + + + + + + + +
                                TypeNameDescription
                                System.Objectobj
                                +
                                Returns
                                + + + + + + + + + + + + + +
                                TypeDescription
                                System.Booleantrue if the two objects are equal
                                +
                                Overrides
                                +
                                System.Object.Equals(System.Object)
                                + +

                                Equals(ColorScheme)

                                +
                                +Compares two ColorScheme objects for equality. +
                                +
                                +
                                Declaration
                                +
                                + 
                                public bool Equals(ColorScheme other)
                                +
                                +
                                Parameters
                                + + + + + + + + + + + + + + + +
                                TypeNameDescription
                                ColorSchemeother
                                +
                                Returns
                                + + + + + + + + + + + + + +
                                TypeDescription
                                System.Booleantrue if the two objects are equal
                                + +

                                GetHashCode()

                                +
                                +Returns a hashcode for this instance. +
                                +
                                +
                                Declaration
                                +
                                + 
                                public override int GetHashCode()
                                +
                                +
                                Returns
                                + + + + + + + + + + + + + +
                                TypeDescription
                                System.Int32hashcode for this instance
                                +
                                Overrides
                                +
                                System.Object.GetHashCode()
                                +

                                Operators +

                                + +

                                Equality(ColorScheme, ColorScheme)

                                +
                                +Compares two ColorScheme objects for equality. +
                                +
                                +
                                Declaration
                                +
                                + 
                                public static bool operator ==(ColorScheme left, ColorScheme right)
                                +
                                +
                                Parameters
                                + + + + + + + + + + + + + + + + + + + + +
                                TypeNameDescription
                                ColorSchemeleft
                                ColorSchemeright
                                +
                                Returns
                                + + + + + + + + + + + + + +
                                TypeDescription
                                System.Booleantrue if the two objects are equivalent
                                + +

                                Inequality(ColorScheme, ColorScheme)

                                +
                                +Compares two ColorScheme objects for inequality. +
                                +
                                +
                                Declaration
                                +
                                + 
                                public static bool operator !=(ColorScheme left, ColorScheme right)
                                +
                                +
                                Parameters
                                + + + + + + + + + + + + + + + + + + + + +
                                TypeNameDescription
                                ColorSchemeleft
                                ColorSchemeright
                                +
                                Returns
                                + + + + + + + + + + + + + +
                                TypeDescription
                                System.Booleantrue if the two objects are not equivalent
                                +

                                Implements

                                +
                                + System.IEquatable<T> +
                                +
                                +
                                + + +
                                +
                                + + +
                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Colors.html b/docs/api/Terminal.Gui/Terminal.Gui.Colors.html new file mode 100644 index 0000000000..32a58b5e95 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Colors.html @@ -0,0 +1,339 @@ + + + + + + + + Class Colors + + + + + + + + + + + + + + + + +
                                +
                                + + + +
                                + +
                                +
                                +
                                + +
                                +
                                Search Results for
                                +
                                +

                                +
                                +
                                  +
                                  +
                                  +
                                  + +
                                  + +
                                  +
                                  +
                                  +
                                  +
                                  +
                                  +
                                  + + +

                                  Class Colors +

                                  +
                                  +The default ColorSchemes for the application. +
                                  +
                                  +
                                  +
                                  Inheritance
                                  +
                                  System.Object
                                  +
                                  Colors
                                  +
                                  +
                                  +
                                  Inherited Members
                                  +
                                  + System.Object.Equals(System.Object) +
                                  +
                                  + System.Object.Equals(System.Object, System.Object) +
                                  +
                                  + System.Object.GetHashCode() +
                                  +
                                  + System.Object.GetType() +
                                  +
                                  + System.Object.MemberwiseClone() +
                                  +
                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                  +
                                  + System.Object.ToString() +
                                  +
                                  +
                                  Namespace: Terminal.Gui
                                  +
                                  Assembly: Terminal.Gui.dll
                                  +
                                  Syntax
                                  +
                                  + 
                                  public static class Colors
                                  +
                                  +

                                  Properties +

                                  + +

                                  Base

                                  +
                                  +The base color scheme, for the default toplevel views. +
                                  +
                                  +
                                  Declaration
                                  +
                                  + 
                                  public static ColorScheme Base { get; set; }
                                  +
                                  +
                                  Property Value
                                  + + + + + + + + + + + + + +
                                  TypeDescription
                                  ColorScheme
                                  +
                                  Remarks
                                  +
                                  +

                                  +This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes["Base"]; +

                                  +
                                  + +

                                  ColorSchemes

                                  +
                                  +Provides the defined ColorSchemes. +
                                  +
                                  +
                                  Declaration
                                  +
                                  + 
                                  public static Dictionary<string, ColorScheme> ColorSchemes { get; }
                                  +
                                  +
                                  Property Value
                                  + + + + + + + + + + + + + +
                                  TypeDescription
                                  System.Collections.Generic.Dictionary<System.String, ColorScheme>
                                  + +

                                  Dialog

                                  +
                                  +The dialog color scheme, for standard popup dialog boxes +
                                  +
                                  +
                                  Declaration
                                  +
                                  + 
                                  public static ColorScheme Dialog { get; set; }
                                  +
                                  +
                                  Property Value
                                  + + + + + + + + + + + + + +
                                  TypeDescription
                                  ColorScheme
                                  +
                                  Remarks
                                  +
                                  +

                                  +This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes["Dialog"]; +

                                  +
                                  + +

                                  Error

                                  +
                                  +The color scheme for showing errors. +
                                  +
                                  +
                                  Declaration
                                  +
                                  + 
                                  public static ColorScheme Error { get; set; }
                                  +
                                  +
                                  Property Value
                                  + + + + + + + + + + + + + +
                                  TypeDescription
                                  ColorScheme
                                  +
                                  Remarks
                                  +
                                  +

                                  +This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes["Error"]; +

                                  +
                                  + +

                                  Menu

                                  +
                                  +The menu bar color +
                                  +
                                  +
                                  Declaration
                                  +
                                  + 
                                  public static ColorScheme Menu { get; set; }
                                  +
                                  +
                                  Property Value
                                  + + + + + + + + + + + + + +
                                  TypeDescription
                                  ColorScheme
                                  +
                                  Remarks
                                  +
                                  +

                                  +This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes["Menu"]; +

                                  +
                                  + +

                                  TopLevel

                                  +
                                  +The application toplevel color scheme, for the default toplevel views. +
                                  +
                                  +
                                  Declaration
                                  +
                                  + 
                                  public static ColorScheme TopLevel { get; set; }
                                  +
                                  +
                                  Property Value
                                  + + + + + + + + + + + + + +
                                  TypeDescription
                                  ColorScheme
                                  +
                                  Remarks
                                  +
                                  +

                                  +This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes["TopLevel"]; +

                                  +
                                  +
                                  +
                                  + + +
                                  +
                                  + + +
                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ComboBox.html b/docs/api/Terminal.Gui/Terminal.Gui.ComboBox.html new file mode 100644 index 0000000000..e2e36bc284 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ComboBox.html @@ -0,0 +1,1176 @@ + + + + + + + + Class ComboBox + + + + + + + + + + + + + + + + +
                                  +
                                  + + + +
                                  + +
                                  +
                                  +
                                  + +
                                  +
                                  Search Results for
                                  +
                                  +

                                  +
                                  +
                                    +
                                    +
                                    +
                                    + +
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    + + +

                                    Class ComboBox +

                                    +
                                    +ComboBox control +
                                    +
                                    +
                                    +
                                    Inheritance
                                    +
                                    System.Object
                                    +
                                    Responder
                                    +
                                    View
                                    +
                                    ComboBox
                                    +
                                    +
                                    +
                                    Implements
                                    +
                                    System.IDisposable
                                    +
                                    System.ComponentModel.ISupportInitializeNotification
                                    +
                                    System.ComponentModel.ISupportInitialize
                                    +
                                    +
                                    +
                                    Inherited Members
                                    + + + + + + + + + + + + + + + + +
                                    + View.Data +
                                    + + + + + + +
                                    + View.Id +
                                    + + + + + + +
                                    + View.X +
                                    +
                                    + View.Y +
                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                    + System.Object.Equals(System.Object) +
                                    +
                                    + System.Object.Equals(System.Object, System.Object) +
                                    +
                                    + System.Object.GetHashCode() +
                                    +
                                    + System.Object.GetType() +
                                    +
                                    + System.Object.MemberwiseClone() +
                                    +
                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                    +
                                    +
                                    Namespace: Terminal.Gui
                                    +
                                    Assembly: Terminal.Gui.dll
                                    +
                                    Syntax
                                    +
                                    + 
                                    public class ComboBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                    +
                                    +

                                    Constructors +

                                    + +

                                    ComboBox()

                                    +
                                    +Public constructor +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public ComboBox()
                                    +
                                    + +

                                    ComboBox(ustring)

                                    +
                                    +Public constructor +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public ComboBox(ustring text)
                                    +
                                    +
                                    Parameters
                                    + + + + + + + + + + + + + + + +
                                    TypeNameDescription
                                    NStack.ustringtext
                                    + +

                                    ComboBox(Rect, IList)

                                    +
                                    +Public constructor +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public ComboBox(Rect rect, IList source)
                                    +
                                    +
                                    Parameters
                                    + + + + + + + + + + + + + + + + + + + + +
                                    TypeNameDescription
                                    Rectrect
                                    System.Collections.IListsource
                                    +

                                    Properties +

                                    + +

                                    ColorScheme

                                    +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public ColorScheme ColorScheme { get; set; }
                                    +
                                    +
                                    Property Value
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    ColorScheme
                                    + +

                                    IsShow

                                    +
                                    +Gets the drop down list state, expanded or collapsed. +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public bool IsShow { get; }
                                    +
                                    +
                                    Property Value
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    System.Boolean
                                    + +

                                    ReadOnly

                                    +
                                    +If set to true its not allow any changes in the text. +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public bool ReadOnly { get; set; }
                                    +
                                    +
                                    Property Value
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    System.Boolean
                                    + +

                                    SelectedItem

                                    +
                                    +Gets the index of the currently selected item in the Source +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public int SelectedItem { get; set; }
                                    +
                                    +
                                    Property Value
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    System.Int32The selected item or -1 none selected.
                                    + +

                                    Source

                                    +
                                    +Gets or sets the IListDataSource backing this ComboBox, enabling custom rendering. +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public IListDataSource Source { get; set; }
                                    +
                                    +
                                    Property Value
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    IListDataSourceThe source.
                                    +
                                    Remarks
                                    +
                                    +Use SetSource(IList) to set a new System.Collections.IList source. +
                                    + +

                                    Text

                                    +
                                    +The currently selected list item +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public ustring Text { get; set; }
                                    +
                                    +
                                    Property Value
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    NStack.ustring
                                    +

                                    Methods +

                                    + +

                                    Collapse()

                                    +
                                    +Collapses the drop down list. Returns true if the state chagned or false +if it was already collapsed and no action was taken +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public virtual bool Collapse()
                                    +
                                    +
                                    Returns
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    System.Boolean
                                    + +

                                    Expand()

                                    +
                                    +Expands the drop down list. Returns true if the state chagned or false +if it was already expanded and no action was taken +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public virtual bool Expand()
                                    +
                                    +
                                    Returns
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    System.Boolean
                                    + +

                                    MouseEvent(MouseEvent)

                                    +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public override bool MouseEvent(MouseEvent me)
                                    +
                                    +
                                    Parameters
                                    + + + + + + + + + + + + + + + +
                                    TypeNameDescription
                                    MouseEventme
                                    +
                                    Returns
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    System.Boolean
                                    +
                                    Overrides
                                    + + +

                                    OnEnter(View)

                                    +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public override bool OnEnter(View view)
                                    +
                                    +
                                    Parameters
                                    + + + + + + + + + + + + + + + +
                                    TypeNameDescription
                                    Viewview
                                    +
                                    Returns
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    System.Boolean
                                    +
                                    Overrides
                                    + + +

                                    OnLeave(View)

                                    +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public override bool OnLeave(View view)
                                    +
                                    +
                                    Parameters
                                    + + + + + + + + + + + + + + + +
                                    TypeNameDescription
                                    Viewview
                                    +
                                    Returns
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    System.Boolean
                                    +
                                    Overrides
                                    + + +

                                    OnOpenSelectedItem()

                                    +
                                    +Invokes the OnOpenSelectedItem event if it is defined. +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public virtual bool OnOpenSelectedItem()
                                    +
                                    +
                                    Returns
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    System.Boolean
                                    + +

                                    OnSelectedChanged()

                                    +
                                    +Invokes the SelectedChanged event if it is defined. +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public virtual bool OnSelectedChanged()
                                    +
                                    +
                                    Returns
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    System.Boolean
                                    + +

                                    ProcessKey(KeyEvent)

                                    +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public override bool ProcessKey(KeyEvent e)
                                    +
                                    +
                                    Parameters
                                    + + + + + + + + + + + + + + + +
                                    TypeNameDescription
                                    KeyEvente
                                    +
                                    Returns
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    System.Boolean
                                    +
                                    Overrides
                                    + + +

                                    Redraw(Rect)

                                    +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public override void Redraw(Rect bounds)
                                    +
                                    +
                                    Parameters
                                    + + + + + + + + + + + + + + + +
                                    TypeNameDescription
                                    Rectbounds
                                    +
                                    Overrides
                                    + + +

                                    SetSource(IList)

                                    +
                                    +Sets the source of the ComboBox to an System.Collections.IList. +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public void SetSource(IList source)
                                    +
                                    +
                                    Parameters
                                    + + + + + + + + + + + + + + + +
                                    TypeNameDescription
                                    System.Collections.IListsource
                                    +
                                    Remarks
                                    +
                                    +Use the Source property to set a new IListDataSource source and use custome rendering. +
                                    +

                                    Events +

                                    +

                                    OpenSelectedItem

                                    +
                                    +This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public event Action<ListViewItemEventArgs> OpenSelectedItem
                                    +
                                    +
                                    Event Type
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    System.Action<ListViewItemEventArgs>
                                    +

                                    SelectedItemChanged

                                    +
                                    +This event is raised when the selected item in the ComboBox has changed. +
                                    +
                                    +
                                    Declaration
                                    +
                                    + 
                                    public event Action<ListViewItemEventArgs> SelectedItemChanged
                                    +
                                    +
                                    Event Type
                                    + + + + + + + + + + + + + +
                                    TypeDescription
                                    System.Action<ListViewItemEventArgs>
                                    +

                                    Implements

                                    +
                                    + System.IDisposable +
                                    +
                                    + System.ComponentModel.ISupportInitializeNotification +
                                    +
                                    + System.ComponentModel.ISupportInitialize +
                                    +
                                    +
                                    + + +
                                    +
                                    + + +
                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Command.html b/docs/api/Terminal.Gui/Terminal.Gui.Command.html new file mode 100644 index 0000000000..93fe9068f7 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Command.html @@ -0,0 +1,593 @@ + + + + + + + + Enum Command + + + + + + + + + + + + + + + + +
                                    +
                                    + + + +
                                    + +
                                    +
                                    +
                                    + +
                                    +
                                    Search Results for
                                    +
                                    +

                                    +
                                    +
                                      +
                                      +
                                      +
                                      + +
                                      + +
                                      +
                                      +
                                      +
                                      +
                                      +
                                      +
                                      + + +

                                      Enum Command +

                                      +
                                      +Actions which can be performed by the application or bound to keys in a View control. +
                                      +
                                      +
                                      Namespace: Terminal.Gui
                                      +
                                      Assembly: Terminal.Gui.dll
                                      +
                                      Syntax
                                      +
                                      + 
                                      public enum Command
                                      +
                                      +

                                      Fields +

                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                      NameDescription
                                      Accept +Accepts the current state (e.g. selection, button press etc) +
                                      BackTab +Inserts a shift tab. +
                                      BottomEnd +Moves to bottom end. +
                                      BottomEndExtend +Extends the selection to the bottom end. +
                                      Cancel +Cancels any current temporary states on the control e.g. expanding +a combo list +
                                      Collapse +Collapses a list or item (with subitems) +
                                      CollapseAll +Recursively collapses a list items of their children (if any) +
                                      Copy +Copies the current selection. +
                                      Cut +Cuts the current selection. +
                                      CutToEndLine +Deletes and copies to the clipboard the characters from the current position to the end of the line. +
                                      CutToStartLine +Deletes and copies to the clipboard the characters from the current position to the start of the line. +
                                      DeleteAll +Deletes all objects in the control. +
                                      DeleteCharLeft +Deletes the character on the left. +
                                      DeleteCharRight +Deletes the character on the right. +
                                      DisableOverwrite +Disables overwrite mode (EnableOverwrite) +
                                      EnableOverwrite +Enables overwrite mode such that newly typed text overwrites the text that is +already there (typically associated with the Insert key). +
                                      EndOfLine +Moves the cursor to the end of line. +
                                      EndOfLineExtend +Extends the selection to the end of line. +
                                      EndOfPage +Moves the cursor to the bottom of page. +
                                      Expand +Expands a list or item (with subitems) +
                                      ExpandAll +Recursively Expands all child items and their child items (if any) +
                                      KillWordBackwards +Deletes the characters backwards. +
                                      KillWordForwards +Deletes the characters forwards. +
                                      Left +Moves the selection left one by the minimum increment supported by the view e.g. single character, cell, item etc. +
                                      LeftExtend +Extends the selection left one by the minimum increment supported by the view e.g. single character, cell, item etc. +
                                      LeftHome +Moves to the left begin. +
                                      LeftHomeExtend +Extends the selection to the left begin. +
                                      LineDown +Moves the caret down one line. +
                                      LineDownExtend +Extends the selection down one line. +
                                      LineDownToLastBranch +Moves the caret down to the last child node of the branch that holds the current selection +
                                      LineUp +Moves the caret up one line. +
                                      LineUpExtend +Extends the selection up one line. +
                                      LineUpToFirstBranch +Moves the caret up to the first child node of the branch that holds the current selection +
                                      NewLine +Inserts a new line. +
                                      NextView +Moves focus to the next view. +
                                      NextViewOrTop +Moves focus to the next view or toplevel (case of Mdi). +
                                      OpenSelectedItem +Open selected item. +
                                      PageDown +Move the page down. +
                                      PageDownExtend +Move the page down increase selection area to cover revealed objects/characters. +
                                      PageLeft +Moves to the left page. +
                                      PageRight +Moves to the right page. +
                                      PageUp +Move the page up. +
                                      PageUpExtend +Move the page up increase selection area to cover revealed objects/characters. +
                                      Paste +Pastes the current selection. +
                                      PreviousView +Moves focuss to the previous view. +
                                      PreviousViewOrTop +Moves focus to the next previous or toplevel (case of Mdi). +
                                      QuitToplevel +Quit a toplevel. +
                                      Redo +Redo changes. +
                                      Refresh +Refresh the application. +
                                      Right +Moves the selection right one by the minimum increment supported by the view e.g. single character, cell, item etc. +
                                      RightEnd +Moves to the right end. +
                                      RightEndExtend +Extends the selection to the right end. +
                                      RightExtend +Extends the selection right one by the minimum increment supported by the view e.g. single character, cell, item etc. +
                                      ScrollDown +Scrolls down one line (without changing the selection). +
                                      ScrollLeft +Scrolls one character to the left +
                                      ScrollRight +Scrolls one character to the right. +
                                      ScrollUp +Scrolls up one line (without changing the selection). +
                                      SelectAll +Selects all objects in the control. +
                                      StartOfLine +Moves the cursor to the start of line. +
                                      StartOfLineExtend +Extends the selection to the start of line. +
                                      StartOfPage +Moves the cursor to the top of page. +
                                      Suspend +Suspend a application (used on Linux). +
                                      Tab +Inserts a tab. +
                                      ToggleChecked +Toggle the checked state. +
                                      ToggleExpandCollapse +Toggles the Expanded or collapsed state of a a list or item (with subitems) +
                                      ToggleExtend +Toggles the extended selection. +
                                      ToggleOverwrite +Toggles overwrite mode such that newly typed text overwrites the text that is +already there (typically associated with the Insert key). +
                                      TopHome +Moves to top begin. +
                                      TopHomeExtend +Extends the selection to the top begin. +
                                      Undo +Undo changes. +
                                      UnixEmulation +Unix emulation +
                                      WordLeft +Moves the caret to the start of the previous word. +
                                      WordLeftExtend +Extends the selection to the start of the previous word. +
                                      WordRight +Moves the caret to the start of the next word. +
                                      WordRightExtend +Extends the selection to the start of the next word. +
                                      +
                                      +
                                      + + +
                                      +
                                      + + +
                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ConsoleDriver.DiagnosticFlags.html b/docs/api/Terminal.Gui/Terminal.Gui.ConsoleDriver.DiagnosticFlags.html new file mode 100644 index 0000000000..6b9ad9bcec --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ConsoleDriver.DiagnosticFlags.html @@ -0,0 +1,161 @@ + + + + + + + + Enum ConsoleDriver.DiagnosticFlags + + + + + + + + + + + + + + + + +
                                      +
                                      + + + +
                                      + +
                                      +
                                      +
                                      + +
                                      +
                                      Search Results for
                                      +
                                      +

                                      +
                                      +
                                        +
                                        +
                                        +
                                        + +
                                        + +
                                        +
                                        +
                                        +
                                        +
                                        +
                                        +
                                        + + +

                                        Enum ConsoleDriver.DiagnosticFlags +

                                        +
                                        +Enables diagnostic functions +
                                        +
                                        +
                                        Namespace: Terminal.Gui
                                        +
                                        Assembly: Terminal.Gui.dll
                                        +
                                        Syntax
                                        +
                                        + 
                                        [Flags]
+public enum DiagnosticFlags : uint
                                        +
                                        +

                                        Fields +

                                        + + + + + + + + + + + + + + + + + + + + + +
                                        NameDescription
                                        FramePadding +When Enabled, DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean, Border) will use +'L', 'R', 'T', and 'B' for padding instead of ' '. +
                                        FrameRuler +When enabled, DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean, Border) will draw a +ruler in the frame for any side with a padding value greater than 0. +
                                        Off +All diagnostics off +
                                        +
                                        +
                                        + + +
                                        +
                                        + + +
                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ConsoleDriver.html b/docs/api/Terminal.Gui/Terminal.Gui.ConsoleDriver.html new file mode 100644 index 0000000000..21ce77432f --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ConsoleDriver.html @@ -0,0 +1,2249 @@ + + + + + + + + Class ConsoleDriver + + + + + + + + + + + + + + + + +
                                        +
                                        + + + +
                                        + +
                                        +
                                        +
                                        + +
                                        +
                                        Search Results for
                                        +
                                        +

                                        +
                                        +
                                          +
                                          +
                                          +
                                          + +
                                          + +
                                          +
                                          +
                                          +
                                          +
                                          +
                                          +
                                          + + +

                                          Class ConsoleDriver +

                                          +
                                          +ConsoleDriver is an abstract class that defines the requirements for a console driver. +There are currently three implementations: Terminal.Gui.CursesDriver (for Unix and Mac), Terminal.Gui.WindowsDriver, and Terminal.Gui.NetDriver that uses the .NET Console API. +
                                          +
                                          +
                                          +
                                          Inheritance
                                          +
                                          System.Object
                                          +
                                          ConsoleDriver
                                          +
                                          FakeDriver
                                          +
                                          +
                                          +
                                          Inherited Members
                                          +
                                          + System.Object.Equals(System.Object) +
                                          +
                                          + System.Object.Equals(System.Object, System.Object) +
                                          +
                                          + System.Object.GetHashCode() +
                                          +
                                          + System.Object.GetType() +
                                          +
                                          + System.Object.MemberwiseClone() +
                                          +
                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                          +
                                          + System.Object.ToString() +
                                          +
                                          +
                                          Namespace: Terminal.Gui
                                          +
                                          Assembly: Terminal.Gui.dll
                                          +
                                          Syntax
                                          +
                                          + 
                                          public abstract class ConsoleDriver
                                          +
                                          +

                                          Fields +

                                          +

                                          BlocksMeterSegment

                                          +
                                          +Blocks Segment indicator for meter views (e.g. ProgressBar. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune BlocksMeterSegment
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          BottomTee

                                          +
                                          +The bottom tee. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune BottomTee
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          Checked

                                          +
                                          +Checkmark. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune Checked
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          ContinuousMeterSegment

                                          +
                                          +Continuous Segment indicator for meter views (e.g. ProgressBar. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune ContinuousMeterSegment
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          Diamond

                                          +
                                          +Diamond character +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune Diamond
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          DownArrow

                                          +
                                          +Down Arrow. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune DownArrow
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          HDLine

                                          +
                                          +Horizontal double line character. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune HDLine
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          HLine

                                          +
                                          +Horizontal line character. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune HLine
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          HRLine

                                          +
                                          +Horizontal line character for rounded corners. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune HRLine
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          LeftArrow

                                          +
                                          +Left Arrow. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune LeftArrow
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          LeftBracket

                                          +
                                          +Left frame/bracket (e.g. '[' for Button). +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune LeftBracket
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          LeftDefaultIndicator

                                          +
                                          +Left indicator for default action (e.g. for Button). +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune LeftDefaultIndicator
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          LeftTee

                                          +
                                          +Left tee +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune LeftTee
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          LLCorner

                                          +
                                          +Lower left corner +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune LLCorner
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          LLDCorner

                                          +
                                          +Lower left double corner +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune LLDCorner
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          LLRCorner

                                          +
                                          +Lower left rounded corner +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune LLRCorner
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          LRCorner

                                          +
                                          +Lower right corner +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune LRCorner
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          LRDCorner

                                          +
                                          +Lower right double corner +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune LRDCorner
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          LRRCorner

                                          +
                                          +Lower right rounded corner +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune LRRCorner
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          RightArrow

                                          +
                                          +Right Arrow. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune RightArrow
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          RightBracket

                                          +
                                          +Right frame/bracket (e.g. ']' for Button). +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune RightBracket
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          RightDefaultIndicator

                                          +
                                          +Right indicator for default action (e.g. for Button). +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune RightDefaultIndicator
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          RightTee

                                          +
                                          +Right tee +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune RightTee
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          Selected

                                          +
                                          +Selected mark. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune Selected
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          Stipple

                                          +
                                          +Stipple pattern +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune Stipple
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          TerminalResized

                                          +
                                          +The handler fired when the terminal is resized. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          protected Action TerminalResized
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Action
                                          +

                                          TopTee

                                          +
                                          +Top tee +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune TopTee
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          ULCorner

                                          +
                                          +Upper left corner +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune ULCorner
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          ULDCorner

                                          +
                                          +Upper left double corner +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune ULDCorner
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          ULRCorner

                                          +
                                          +Upper left rounded corner +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune ULRCorner
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          UnChecked

                                          +
                                          +Un-checked checkmark. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune UnChecked
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          UnSelected

                                          +
                                          +Un-selected selected mark. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune UnSelected
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          UpArrow

                                          +
                                          +Up Arrow. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune UpArrow
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          URCorner

                                          +
                                          +Upper right corner +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune URCorner
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          URDCorner

                                          +
                                          +Upper right double corner +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune URDCorner
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          URRCorner

                                          +
                                          +Upper right rounded corner +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune URRCorner
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          VDLine

                                          +
                                          +Vertical double line character. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune VDLine
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          VLine

                                          +
                                          +Vertical line character. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune VLine
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          VRLine

                                          +
                                          +Vertical line character for rounded corners. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rune VRLine
                                          +
                                          +
                                          Field Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          +

                                          Properties +

                                          + +

                                          Clip

                                          +
                                          +Controls the current clipping region that AddRune/AddStr is subject to. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public Rect Clip { get; set; }
                                          +
                                          +
                                          Property Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          RectThe clip.
                                          + +

                                          Clipboard

                                          +
                                          +Get the operation system clipboard. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract IClipboard Clipboard { get; }
                                          +
                                          +
                                          Property Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          IClipboard
                                          + +

                                          Cols

                                          +
                                          +The current number of columns in the terminal. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract int Cols { get; }
                                          +
                                          +
                                          Property Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Int32
                                          + +

                                          Contents

                                          +
                                          +The format is rows, columns and 3 values on the last column: Rune, Attribute and Dirty Flag +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public virtual int[,, ] Contents { get; }
                                          +
                                          +
                                          Property Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Int32[,,]
                                          + +

                                          Diagnostics

                                          +
                                          +Set flags to enable/disable ConsoleDriver diagnostics. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public static ConsoleDriver.DiagnosticFlags Diagnostics { get; set; }
                                          +
                                          +
                                          Property Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          ConsoleDriver.DiagnosticFlags
                                          + +

                                          HeightAsBuffer

                                          +
                                          +If false height is measured by the window height and thus no scrolling. +If true then height is measured by the buffer height, enabling scrolling. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract bool HeightAsBuffer { get; set; }
                                          +
                                          +
                                          Property Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Boolean
                                          + +

                                          Left

                                          +
                                          +The current left in the terminal. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract int Left { get; }
                                          +
                                          +
                                          Property Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Int32
                                          + +

                                          Rows

                                          +
                                          +The current number of rows in the terminal. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract int Rows { get; }
                                          +
                                          +
                                          Property Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Int32
                                          + +

                                          Top

                                          +
                                          +The current top in the terminal. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract int Top { get; }
                                          +
                                          +
                                          Property Value
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Int32
                                          +

                                          Methods +

                                          + +

                                          AddRune(Rune)

                                          +
                                          +Adds the specified rune to the display at the current cursor position +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void AddRune(Rune rune)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          System.RuneruneRune to add.
                                          + +

                                          AddStr(ustring)

                                          +
                                          +Adds the specified +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void AddStr(ustring str)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          NStack.ustringstrString.
                                          + +

                                          CookMouse()

                                          +
                                          +Enables the cooked event processing from the mouse driver +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void CookMouse()
                                          +
                                          + +

                                          DrawFrame(Rect, Int32, Boolean)

                                          +
                                          +Draws a frame on the specified region with the specified padding around the frame. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public virtual void DrawFrame(Rect region, int padding, bool fill)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          RectregionScreen relative region where the frame will be drawn.
                                          System.Int32paddingPadding to add on the sides.
                                          System.BooleanfillIf set to true it will clear the contents with the current color, otherwise the contents will be left untouched.
                                          +
                                          Remarks
                                          +
                                          This API has been superseded by DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean, Border).
                                          + +

                                          DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean, Border)

                                          +
                                          +Draws a frame for a window with padding and an optional visible border inside the padding. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public virtual void DrawWindowFrame(Rect region, int paddingLeft = 0, int paddingTop = 0, int paddingRight = 0, int paddingBottom = 0, bool border = true, bool fill = false, Border borderContent = null)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          RectregionScreen relative region where the frame will be drawn.
                                          System.Int32paddingLeftNumber of columns to pad on the left (if 0 the border will not appear on the left).
                                          System.Int32paddingTopNumber of rows to pad on the top (if 0 the border and title will not appear on the top).
                                          System.Int32paddingRightNumber of columns to pad on the right (if 0 the border will not appear on the right).
                                          System.Int32paddingBottomNumber of rows to pad on the bottom (if 0 the border will not appear on the bottom).
                                          System.BooleanborderIf set to true and any padding dimension is > 0 the border will be drawn.
                                          System.BooleanfillIf set to true it will clear the content area (the area inside the padding) with the current color, otherwise the content area will be left untouched.
                                          BorderborderContentThe Border to be used if defined.
                                          + +

                                          DrawWindowTitle(Rect, ustring, Int32, Int32, Int32, Int32, TextAlignment)

                                          +
                                          +Draws the title for a Window-style view incorporating padding. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public virtual void DrawWindowTitle(Rect region, ustring title, int paddingLeft, int paddingTop, int paddingRight, int paddingBottom, TextAlignment textAlignment = TextAlignment.Left)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          RectregionScreen relative region where the frame will be drawn.
                                          NStack.ustringtitleThe title for the window. The title will only be drawn if title is not null or empty and paddingTop is greater than 0.
                                          System.Int32paddingLeftNumber of columns to pad on the left (if 0 the border will not appear on the left).
                                          System.Int32paddingTopNumber of rows to pad on the top (if 0 the border and title will not appear on the top).
                                          System.Int32paddingRightNumber of columns to pad on the right (if 0 the border will not appear on the right).
                                          System.Int32paddingBottomNumber of rows to pad on the bottom (if 0 the border will not appear on the bottom).
                                          TextAlignmenttextAlignmentNot yet implemented.
                                          + +

                                          End()

                                          +
                                          +Ends the execution of the console driver. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void End()
                                          +
                                          + +

                                          EnsureCursorVisibility()

                                          +
                                          +Ensure the cursor visibility +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract bool EnsureCursorVisibility()
                                          +
                                          +
                                          Returns
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Booleantrue upon success
                                          + +

                                          GetAttribute()

                                          +
                                          +Gets the current Attribute. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract Attribute GetAttribute()
                                          +
                                          +
                                          Returns
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          AttributeThe current attribute.
                                          + +

                                          GetColors(Int32, out Color, out Color)

                                          +
                                          +Gets the foreground and background colors based on the value. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract bool GetColors(int value, out Color foreground, out Color background)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          System.Int32valueThe value.
                                          ColorforegroundThe foreground.
                                          ColorbackgroundThe background.
                                          +
                                          Returns
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Boolean
                                          + +

                                          GetCursorVisibility(out CursorVisibility)

                                          +
                                          +Retreive the cursor caret visibility +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract bool GetCursorVisibility(out CursorVisibility visibility)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          CursorVisibilityvisibilityThe current CursorVisibility
                                          +
                                          Returns
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Booleantrue upon success
                                          + +

                                          Init(Action)

                                          +
                                          +Initializes the driver +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void Init(Action terminalResized)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          System.ActionterminalResizedMethod to invoke when the terminal is resized.
                                          + +

                                          IsValidContent(Int32, Int32, Rect)

                                          +
                                          +Ensures that the column and line are in a valid range from the size of the driver. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public bool IsValidContent(int col, int row, Rect clip)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          System.Int32colThe column.
                                          System.Int32rowThe row.
                                          RectclipThe clip.
                                          +
                                          Returns
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Booleantrueif it's a valid range,falseotherwise.
                                          + +

                                          MakeAttribute(Color, Color)

                                          +
                                          +Make the attribute for the foreground and background colors. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract Attribute MakeAttribute(Color fore, Color back)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          ColorforeForeground.
                                          ColorbackBackground.
                                          +
                                          Returns
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          Attribute
                                          + +

                                          MakePrintable(Rune)

                                          +
                                          +Ensures a Rune is not a control character and can be displayed by translating characters below 0x20 +to equivalent, printable, Unicode chars. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public static Rune MakePrintable(Rune c)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          System.RunecRune to translate
                                          +
                                          Returns
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Rune
                                          + +

                                          Move(Int32, Int32)

                                          +
                                          +Moves the cursor to the specified column and row. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void Move(int col, int row)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          System.Int32colColumn to move the cursor to.
                                          System.Int32rowRow to move the cursor to.
                                          + +

                                          PrepareToRun(MainLoop, Action<KeyEvent>, Action<KeyEvent>, Action<KeyEvent>, Action<MouseEvent>)

                                          +
                                          +Prepare the driver and set the key and mouse events handlers. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void PrepareToRun(MainLoop mainLoop, Action<KeyEvent> keyHandler, Action<KeyEvent> keyDownHandler, Action<KeyEvent> keyUpHandler, Action<MouseEvent> mouseHandler)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          MainLoopmainLoopThe main loop.
                                          System.Action<KeyEvent>keyHandlerThe handler for ProcessKey
                                          System.Action<KeyEvent>keyDownHandlerThe handler for key down events
                                          System.Action<KeyEvent>keyUpHandlerThe handler for key up events
                                          System.Action<MouseEvent>mouseHandlerThe handler for mouse events
                                          + +

                                          Refresh()

                                          +
                                          +Updates the screen to reflect all the changes that have been done to the display buffer +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void Refresh()
                                          +
                                          + +

                                          ResizeScreen()

                                          +
                                          +Resizes the clip area when the screen is resized. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void ResizeScreen()
                                          +
                                          + +

                                          SendKeys(Char, ConsoleKey, Boolean, Boolean, Boolean)

                                          +
                                          +Allows sending keys without typing on a keyboard. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void SendKeys(char keyChar, ConsoleKey key, bool shift, bool alt, bool control)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          System.CharkeyCharThe character key.
                                          System.ConsoleKeykeyThe key.
                                          System.BooleanshiftIf shift key is sending.
                                          System.BooleanaltIf alt key is sending.
                                          System.BooleancontrolIf control key is sending.
                                          + +

                                          SetAttribute(Attribute)

                                          +
                                          +Selects the specified attribute as the attribute to use for future calls to AddRune, AddString. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void SetAttribute(Attribute c)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          AttributecC.
                                          + +

                                          SetColors(ConsoleColor, ConsoleColor)

                                          +
                                          +Set Colors from limit sets of colors. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void SetColors(ConsoleColor foreground, ConsoleColor background)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          System.ConsoleColorforegroundForeground.
                                          System.ConsoleColorbackgroundBackground.
                                          + +

                                          SetColors(Int16, Int16)

                                          +
                                          +Advanced uses - set colors to any pre-set pairs, you would need to init_color +that independently with the R, G, B values. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void SetColors(short foregroundColorId, short backgroundColorId)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          System.Int16foregroundColorIdForeground color identifier.
                                          System.Int16backgroundColorIdBackground color identifier.
                                          + +

                                          SetCursorVisibility(CursorVisibility)

                                          +
                                          +Change the cursor caret visibility +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract bool SetCursorVisibility(CursorVisibility visibility)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          CursorVisibilityvisibilityThe wished CursorVisibility
                                          +
                                          Returns
                                          + + + + + + + + + + + + + +
                                          TypeDescription
                                          System.Booleantrue upon success
                                          + +

                                          SetTerminalResized(Action)

                                          +
                                          +Set the handler when the terminal is resized. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public void SetTerminalResized(Action terminalResized)
                                          +
                                          +
                                          Parameters
                                          + + + + + + + + + + + + + + + +
                                          TypeNameDescription
                                          System.ActionterminalResized
                                          + +

                                          StartReportingMouseMoves()

                                          +
                                          +Start of mouse moves. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void StartReportingMouseMoves()
                                          +
                                          + +

                                          StopReportingMouseMoves()

                                          +
                                          +Stop reporting mouses moves. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void StopReportingMouseMoves()
                                          +
                                          + +

                                          Suspend()

                                          +
                                          +Suspend the application, typically needs to save the state, suspend the app and upon return, reset the console driver. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void Suspend()
                                          +
                                          + +

                                          UncookMouse()

                                          +
                                          +Disables the cooked event processing from the mouse driver. At startup, it is assumed mouse events are cooked. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void UncookMouse()
                                          +
                                          + +

                                          UpdateCursor()

                                          +
                                          +Updates the location of the cursor position +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void UpdateCursor()
                                          +
                                          + +

                                          UpdateOffScreen()

                                          +
                                          +Reset and recreate the contents and the driver buffer. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void UpdateOffScreen()
                                          +
                                          + +

                                          UpdateScreen()

                                          +
                                          +Redraws the physical screen with the contents that have been queued up via any of the printing commands. +
                                          +
                                          +
                                          Declaration
                                          +
                                          + 
                                          public abstract void UpdateScreen()
                                          +
                                          +
                                          +
                                          + + +
                                          +
                                          + + +
                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ContextMenu.html b/docs/api/Terminal.Gui/Terminal.Gui.ContextMenu.html new file mode 100644 index 0000000000..0353933618 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ContextMenu.html @@ -0,0 +1,558 @@ + + + + + + + + Class ContextMenu + + + + + + + + + + + + + + + + +
                                          +
                                          + + + +
                                          + +
                                          +
                                          +
                                          + +
                                          +
                                          Search Results for
                                          +
                                          +

                                          +
                                          +
                                            +
                                            +
                                            +
                                            + +
                                            + +
                                            +
                                            +
                                            +
                                            +
                                            +
                                            +
                                            + + +

                                            Class ContextMenu +

                                            +
                                            +A context menu window derived from MenuBar containing menu items +which can be opened in any position. +
                                            +
                                            +
                                            +
                                            Inheritance
                                            +
                                            System.Object
                                            +
                                            ContextMenu
                                            +
                                            +
                                            +
                                            Implements
                                            +
                                            System.IDisposable
                                            +
                                            +
                                            +
                                            Inherited Members
                                            +
                                            + System.Object.Equals(System.Object) +
                                            +
                                            + System.Object.Equals(System.Object, System.Object) +
                                            +
                                            + System.Object.GetHashCode() +
                                            +
                                            + System.Object.GetType() +
                                            +
                                            + System.Object.MemberwiseClone() +
                                            +
                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                            +
                                            + System.Object.ToString() +
                                            +
                                            +
                                            Namespace: Terminal.Gui
                                            +
                                            Assembly: Terminal.Gui.dll
                                            +
                                            Syntax
                                            +
                                            + 
                                            public sealed class ContextMenu : IDisposable
                                            +
                                            +

                                            Constructors +

                                            + +

                                            ContextMenu()

                                            +
                                            +Initialize a context menu with empty menu items. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public ContextMenu()
                                            +
                                            + +

                                            ContextMenu(Int32, Int32, MenuBarItem)

                                            +
                                            +Initialize a context menu with menu items. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public ContextMenu(int x, int y, MenuBarItem menuItems)
                                            +
                                            +
                                            Parameters
                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                            TypeNameDescription
                                            System.Int32xThe left position.
                                            System.Int32yThe top position.
                                            MenuBarItemmenuItemsThe menu items.
                                            + +

                                            ContextMenu(View, MenuBarItem)

                                            +
                                            +Initialize a context menu with menu items from a host View. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public ContextMenu(View host, MenuBarItem menuItems)
                                            +
                                            +
                                            Parameters
                                            + + + + + + + + + + + + + + + + + + + + +
                                            TypeNameDescription
                                            ViewhostThe host view.
                                            MenuBarItemmenuItemsThe menu items.
                                            +

                                            Properties +

                                            + +

                                            ForceMinimumPosToZero

                                            +
                                            +Gets or sets whether forces the minimum position to zero +if the left or right position are negative. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public bool ForceMinimumPosToZero { get; set; }
                                            +
                                            +
                                            Property Value
                                            + + + + + + + + + + + + + +
                                            TypeDescription
                                            System.Boolean
                                            + +

                                            Host

                                            +
                                            +The host View which position will be used, +otherwise if it's null the container will be used. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public View Host { get; set; }
                                            +
                                            +
                                            Property Value
                                            + + + + + + + + + + + + + +
                                            TypeDescription
                                            View
                                            + +

                                            IsShow

                                            +
                                            +Gets information whether menu is showing or not. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public static bool IsShow { get; }
                                            +
                                            +
                                            Property Value
                                            + + + + + + + + + + + + + +
                                            TypeDescription
                                            System.Boolean
                                            + +

                                            Key

                                            +
                                            +The Key used to activate the context menu by keyboard. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public Key Key { get; set; }
                                            +
                                            +
                                            Property Value
                                            + + + + + + + + + + + + + +
                                            TypeDescription
                                            Key
                                            + +

                                            MenuBar

                                            +
                                            +Gets the MenuBar that is hosting this context menu. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public MenuBar MenuBar { get; }
                                            +
                                            +
                                            Property Value
                                            + + + + + + + + + + + + + +
                                            TypeDescription
                                            MenuBar
                                            + +

                                            MenuItems

                                            +
                                            +Gets or sets the menu items for this context menu. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public MenuBarItem MenuItems { get; set; }
                                            +
                                            +
                                            Property Value
                                            + + + + + + + + + + + + + +
                                            TypeDescription
                                            MenuBarItem
                                            + +

                                            MouseFlags

                                            +
                                            +The MouseFlags used to activate the context menu by mouse. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public MouseFlags MouseFlags { get; set; }
                                            +
                                            +
                                            Property Value
                                            + + + + + + + + + + + + + +
                                            TypeDescription
                                            MouseFlags
                                            + +

                                            Position

                                            +
                                            +Gets or set the menu position. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public Point Position { get; set; }
                                            +
                                            +
                                            Property Value
                                            + + + + + + + + + + + + + +
                                            TypeDescription
                                            Point
                                            + +

                                            UseSubMenusSingleFrame

                                            +
                                            +Gets or sets if the sub-menus must be displayed in a single or multiple frames. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public bool UseSubMenusSingleFrame { get; set; }
                                            +
                                            +
                                            Property Value
                                            + + + + + + + + + + + + + +
                                            TypeDescription
                                            System.Boolean
                                            +

                                            Methods +

                                            + +

                                            Dispose()

                                            +
                                            +Disposes the all the context menu objects instances. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public void Dispose()
                                            +
                                            + +

                                            Hide()

                                            +
                                            +Close the MenuItems menu items. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public void Hide()
                                            +
                                            + +

                                            Show()

                                            +
                                            +Open the MenuItems menu items. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public void Show()
                                            +
                                            +

                                            Events +

                                            +

                                            KeyChanged

                                            +
                                            +Event invoked when the Key is changed. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public event Action<Key> KeyChanged
                                            +
                                            +
                                            Event Type
                                            + + + + + + + + + + + + + +
                                            TypeDescription
                                            System.Action<Key>
                                            +

                                            MouseFlagsChanged

                                            +
                                            +Event invoked when the MouseFlags is changed. +
                                            +
                                            +
                                            Declaration
                                            +
                                            + 
                                            public event Action<MouseFlags> MouseFlagsChanged
                                            +
                                            +
                                            Event Type
                                            + + + + + + + + + + + + + +
                                            TypeDescription
                                            System.Action<MouseFlags>
                                            +

                                            Implements

                                            +
                                            + System.IDisposable +
                                            +
                                            +
                                            + + +
                                            +
                                            + + +
                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.CursorVisibility.html b/docs/api/Terminal.Gui/Terminal.Gui.CursorVisibility.html new file mode 100644 index 0000000000..7e73d90972 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.CursorVisibility.html @@ -0,0 +1,188 @@ + + + + + + + + Enum CursorVisibility + + + + + + + + + + + + + + + + +
                                            +
                                            + + + +
                                            + +
                                            +
                                            +
                                            + +
                                            +
                                            Search Results for
                                            +
                                            +

                                            +
                                            +
                                              +
                                              +
                                              +
                                              + +
                                              + +
                                              +
                                              +
                                              +
                                              +
                                              +
                                              +
                                              + + +

                                              Enum CursorVisibility +

                                              +
                                              +Cursors Visibility that are displayed +
                                              +
                                              +
                                              Namespace: Terminal.Gui
                                              +
                                              Assembly: Terminal.Gui.dll
                                              +
                                              Syntax
                                              +
                                              + 
                                              public enum CursorVisibility
                                              +
                                              +

                                              Fields +

                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                              NameDescription
                                              Box +Cursor caret is displayed as a blinking block ▉ +
                                              BoxFix +Cursor caret is displayed a block ▉ +
                                              Default +Cursor caret has default +
                                              Invisible +Cursor caret is hidden +
                                              Underline +Cursor caret is normally shown as a blinking underline bar _ +
                                              UnderlineFix +Cursor caret is normally shown as a underline bar _ +
                                              Vertical +Cursor caret is displayed a blinking vertical bar | +
                                              VerticalFix +Cursor caret is displayed a blinking vertical bar | +
                                              +
                                              +
                                              + + +
                                              +
                                              + + +
                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.DateField.html b/docs/api/Terminal.Gui/Terminal.Gui.DateField.html new file mode 100644 index 0000000000..6c594de3e6 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.DateField.html @@ -0,0 +1,1007 @@ + + + + + + + + Class DateField + + + + + + + + + + + + + + + + +
                                              +
                                              + + + +
                                              + +
                                              +
                                              +
                                              + +
                                              +
                                              Search Results for
                                              +
                                              +

                                              +
                                              +
                                                +
                                                +
                                                +
                                                + +
                                                + +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                + + +

                                                Class DateField +

                                                +
                                                +Simple Date editing View +
                                                +
                                                +
                                                +
                                                Inheritance
                                                +
                                                System.Object
                                                +
                                                Responder
                                                +
                                                View
                                                +
                                                TextField
                                                +
                                                DateField
                                                +
                                                +
                                                +
                                                Implements
                                                +
                                                System.IDisposable
                                                +
                                                System.ComponentModel.ISupportInitializeNotification
                                                +
                                                System.ComponentModel.ISupportInitialize
                                                +
                                                +
                                                +
                                                Inherited Members
                                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                + View.Data +
                                                + + + + + +
                                                + View.Id +
                                                + + + + + +
                                                + View.X +
                                                +
                                                + View.Y +
                                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                + System.Object.Equals(System.Object) +
                                                +
                                                + System.Object.Equals(System.Object, System.Object) +
                                                +
                                                + System.Object.GetHashCode() +
                                                +
                                                + System.Object.GetType() +
                                                +
                                                + System.Object.MemberwiseClone() +
                                                +
                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                +
                                                +
                                                Namespace: Terminal.Gui
                                                +
                                                Assembly: Terminal.Gui.dll
                                                +
                                                Syntax
                                                +
                                                + 
                                                public class DateField : TextField, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                +
                                                +
                                                Remarks
                                                +
                                                +The DateField View provides date editing functionality with mouse support. +
                                                +

                                                Constructors +

                                                + +

                                                DateField()

                                                +
                                                +Initializes a new instance of DateField using Computed layout. +
                                                +
                                                +
                                                Declaration
                                                +
                                                + 
                                                public DateField()
                                                +
                                                + +

                                                DateField(DateTime)

                                                +
                                                +Initializes a new instance of DateField using Computed layout. +
                                                +
                                                +
                                                Declaration
                                                +
                                                + 
                                                public DateField(DateTime date)
                                                +
                                                +
                                                Parameters
                                                + + + + + + + + + + + + + + + +
                                                TypeNameDescription
                                                System.DateTimedate
                                                + +

                                                DateField(Int32, Int32, DateTime, Boolean)

                                                +
                                                +Initializes a new instance of DateField using Absolute layout. +
                                                +
                                                +
                                                Declaration
                                                +
                                                + 
                                                public DateField(int x, int y, DateTime date, bool isShort = false)
                                                +
                                                +
                                                Parameters
                                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                TypeNameDescription
                                                System.Int32xThe x coordinate.
                                                System.Int32yThe y coordinate.
                                                System.DateTimedateInitial date contents.
                                                System.BooleanisShortIf true, shows only two digits for the year.
                                                +

                                                Properties +

                                                + +

                                                CursorPosition

                                                +
                                                +
                                                +
                                                Declaration
                                                +
                                                + 
                                                public override int CursorPosition { get; set; }
                                                +
                                                +
                                                Property Value
                                                + + + + + + + + + + + + + +
                                                TypeDescription
                                                System.Int32
                                                +
                                                Overrides
                                                + + +

                                                Date

                                                +
                                                +Gets or sets the date of the DateField. +
                                                +
                                                +
                                                Declaration
                                                +
                                                + 
                                                public DateTime Date { get; set; }
                                                +
                                                +
                                                Property Value
                                                + + + + + + + + + + + + + +
                                                TypeDescription
                                                System.DateTime
                                                +
                                                Remarks
                                                +
                                                +
                                                + +

                                                IsShortFormat

                                                +
                                                +Get or set the date format for the widget. +
                                                +
                                                +
                                                Declaration
                                                +
                                                + 
                                                public bool IsShortFormat { get; set; }
                                                +
                                                +
                                                Property Value
                                                + + + + + + + + + + + + + +
                                                TypeDescription
                                                System.Boolean
                                                +

                                                Methods +

                                                + +

                                                DeleteCharLeft(Boolean)

                                                +
                                                +
                                                +
                                                Declaration
                                                +
                                                + 
                                                public override void DeleteCharLeft(bool useOldCursorPos = true)
                                                +
                                                +
                                                Parameters
                                                + + + + + + + + + + + + + + + +
                                                TypeNameDescription
                                                System.BooleanuseOldCursorPos
                                                +
                                                Overrides
                                                + + +

                                                DeleteCharRight()

                                                +
                                                +
                                                +
                                                Declaration
                                                +
                                                + 
                                                public override void DeleteCharRight()
                                                +
                                                +
                                                Overrides
                                                + + +

                                                MouseEvent(MouseEvent)

                                                +
                                                +
                                                +
                                                Declaration
                                                +
                                                + 
                                                public override bool MouseEvent(MouseEvent ev)
                                                +
                                                +
                                                Parameters
                                                + + + + + + + + + + + + + + + +
                                                TypeNameDescription
                                                MouseEventev
                                                +
                                                Returns
                                                + + + + + + + + + + + + + +
                                                TypeDescription
                                                System.Boolean
                                                +
                                                Overrides
                                                + + +

                                                OnDateChanged(DateTimeEventArgs<DateTime>)

                                                +
                                                +Event firing method for the DateChanged event. +
                                                +
                                                +
                                                Declaration
                                                +
                                                + 
                                                public virtual void OnDateChanged(DateTimeEventArgs<DateTime> args)
                                                +
                                                +
                                                Parameters
                                                + + + + + + + + + + + + + + + +
                                                TypeNameDescription
                                                DateTimeEventArgs<System.DateTime>argsEvent arguments
                                                + +

                                                ProcessKey(KeyEvent)

                                                +
                                                +
                                                +
                                                Declaration
                                                +
                                                + 
                                                public override bool ProcessKey(KeyEvent kb)
                                                +
                                                +
                                                Parameters
                                                + + + + + + + + + + + + + + + +
                                                TypeNameDescription
                                                KeyEventkb
                                                +
                                                Returns
                                                + + + + + + + + + + + + + +
                                                TypeDescription
                                                System.Boolean
                                                +
                                                Overrides
                                                + +

                                                Events +

                                                +

                                                DateChanged

                                                +
                                                +DateChanged event, raised when the Date property has changed. +
                                                +
                                                +
                                                Declaration
                                                +
                                                + 
                                                public event Action<DateTimeEventArgs<DateTime>> DateChanged
                                                +
                                                +
                                                Event Type
                                                + + + + + + + + + + + + + +
                                                TypeDescription
                                                System.Action<DateTimeEventArgs<System.DateTime>>
                                                +
                                                Remarks
                                                +
                                                +This event is raised when the Date property changes. +
                                                +

                                                Implements

                                                +
                                                + System.IDisposable +
                                                +
                                                + System.ComponentModel.ISupportInitializeNotification +
                                                +
                                                + System.ComponentModel.ISupportInitialize +
                                                +
                                                +
                                                + + +
                                                +
                                                + + +
                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.DateTimeEventArgs-1.html b/docs/api/Terminal.Gui/Terminal.Gui.DateTimeEventArgs-1.html new file mode 100644 index 0000000000..5c516e8287 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.DateTimeEventArgs-1.html @@ -0,0 +1,292 @@ + + + + + + + + Class DateTimeEventArgs<T> + + + + + + + + + + + + + + + + +
                                                +
                                                + + + +
                                                + +
                                                +
                                                +
                                                + +
                                                +
                                                Search Results for
                                                +
                                                +

                                                +
                                                +
                                                  +
                                                  +
                                                  +
                                                  + +
                                                  + +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  + + +

                                                  Class DateTimeEventArgs<T> +

                                                  +
                                                  +Defines the event arguments for DateChanged and TimeChanged events. +
                                                  +
                                                  +
                                                  +
                                                  Inheritance
                                                  +
                                                  System.Object
                                                  +
                                                  System.EventArgs
                                                  +
                                                  DateTimeEventArgs<T>
                                                  +
                                                  +
                                                  +
                                                  Inherited Members
                                                  +
                                                  + System.EventArgs.Empty +
                                                  +
                                                  + System.Object.Equals(System.Object) +
                                                  +
                                                  + System.Object.Equals(System.Object, System.Object) +
                                                  +
                                                  + System.Object.GetHashCode() +
                                                  +
                                                  + System.Object.GetType() +
                                                  +
                                                  + System.Object.MemberwiseClone() +
                                                  +
                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                  +
                                                  + System.Object.ToString() +
                                                  +
                                                  +
                                                  Namespace: Terminal.Gui
                                                  +
                                                  Assembly: Terminal.Gui.dll
                                                  +
                                                  Syntax
                                                  +
                                                  + 
                                                  public class DateTimeEventArgs<T> : EventArgs
                                                  +
                                                  +
                                                  Type Parameters
                                                  + + + + + + + + + + + + + +
                                                  NameDescription
                                                  T
                                                  +

                                                  Constructors +

                                                  + +

                                                  DateTimeEventArgs(T, T, String)

                                                  +
                                                  +Initializes a new instance of DateTimeEventArgs<T> +
                                                  +
                                                  +
                                                  Declaration
                                                  +
                                                  + 
                                                  public DateTimeEventArgs(T oldValue, T newValue, string format)
                                                  +
                                                  +
                                                  Parameters
                                                  + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                  TypeNameDescription
                                                  ToldValueThe old DateField or TimeField value.
                                                  TnewValueThe new DateField or TimeField value.
                                                  System.StringformatThe DateField or TimeField format string.
                                                  +

                                                  Properties +

                                                  + +

                                                  Format

                                                  +
                                                  +The DateField or TimeField format. +
                                                  +
                                                  +
                                                  Declaration
                                                  +
                                                  + 
                                                  public string Format { get; }
                                                  +
                                                  +
                                                  Property Value
                                                  + + + + + + + + + + + + + +
                                                  TypeDescription
                                                  System.String
                                                  + +

                                                  NewValue

                                                  +
                                                  +The new DateField or TimeField value. +
                                                  +
                                                  +
                                                  Declaration
                                                  +
                                                  + 
                                                  public T NewValue { get; }
                                                  +
                                                  +
                                                  Property Value
                                                  + + + + + + + + + + + + + +
                                                  TypeDescription
                                                  T
                                                  + +

                                                  OldValue

                                                  +
                                                  +The old DateField or TimeField value. +
                                                  +
                                                  +
                                                  Declaration
                                                  +
                                                  + 
                                                  public T OldValue { get; }
                                                  +
                                                  +
                                                  Property Value
                                                  + + + + + + + + + + + + + +
                                                  TypeDescription
                                                  T
                                                  +
                                                  +
                                                  + + +
                                                  +
                                                  + + +
                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Dialog.ButtonAlignments.html b/docs/api/Terminal.Gui/Terminal.Gui.Dialog.ButtonAlignments.html new file mode 100644 index 0000000000..e646341a0c --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Dialog.ButtonAlignments.html @@ -0,0 +1,164 @@ + + + + + + + + Enum Dialog.ButtonAlignments + + + + + + + + + + + + + + + + +
                                                  +
                                                  + + + +
                                                  + +
                                                  +
                                                  +
                                                  + +
                                                  +
                                                  Search Results for
                                                  +
                                                  +

                                                  +
                                                  +
                                                    +
                                                    +
                                                    +
                                                    + +
                                                    + +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    + + +

                                                    Enum Dialog.ButtonAlignments +

                                                    +
                                                    +Determines the horizontal alignment of the Dialog buttons. +
                                                    +
                                                    +
                                                    Namespace: Terminal.Gui
                                                    +
                                                    Assembly: Terminal.Gui.dll
                                                    +
                                                    Syntax
                                                    +
                                                    + 
                                                    public enum ButtonAlignments
                                                    +
                                                    +

                                                    Fields +

                                                    + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                    NameDescription
                                                    Center +Center-aligns the buttons (the default). +
                                                    Justify +Justifies the buttons +
                                                    Left +Left-aligns the buttons +
                                                    Right +Right-aligns the buttons +
                                                    +
                                                    +
                                                    + + +
                                                    +
                                                    + + +
                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Dialog.html b/docs/api/Terminal.Gui/Terminal.Gui.Dialog.html new file mode 100644 index 0000000000..32b0e72e6a --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Dialog.html @@ -0,0 +1,925 @@ + + + + + + + + Class Dialog + + + + + + + + + + + + + + + + +
                                                    +
                                                    + + + +
                                                    + +
                                                    +
                                                    +
                                                    + +
                                                    +
                                                    Search Results for
                                                    +
                                                    +

                                                    +
                                                    +
                                                      +
                                                      +
                                                      +
                                                      + +
                                                      + +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      + + +

                                                      Class Dialog +

                                                      +
                                                      +The Dialog View is a Window that by default is centered and contains one +or more Buttons. It defaults to the Dialog color scheme and has a 1 cell padding around the edges. +
                                                      +
                                                      +
                                                      +
                                                      Inheritance
                                                      +
                                                      System.Object
                                                      +
                                                      Responder
                                                      +
                                                      View
                                                      +
                                                      Toplevel
                                                      +
                                                      Window
                                                      +
                                                      Dialog
                                                      +
                                                      FileDialog
                                                      +
                                                      Wizard
                                                      +
                                                      +
                                                      +
                                                      Implements
                                                      +
                                                      System.IDisposable
                                                      +
                                                      System.ComponentModel.ISupportInitializeNotification
                                                      +
                                                      System.ComponentModel.ISupportInitialize
                                                      +
                                                      +
                                                      +
                                                      Inherited Members
                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                      + View.Data +
                                                      + + + + + +
                                                      + View.Id +
                                                      + + + + + + +
                                                      + View.X +
                                                      +
                                                      + View.Y +
                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                      + System.Object.Equals(System.Object) +
                                                      +
                                                      + System.Object.Equals(System.Object, System.Object) +
                                                      +
                                                      + System.Object.GetHashCode() +
                                                      +
                                                      + System.Object.GetType() +
                                                      +
                                                      + System.Object.MemberwiseClone() +
                                                      +
                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                      +
                                                      +
                                                      Namespace: Terminal.Gui
                                                      +
                                                      Assembly: Terminal.Gui.dll
                                                      +
                                                      Syntax
                                                      +
                                                      + 
                                                      public class Dialog : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                      +
                                                      +
                                                      Remarks
                                                      +
                                                      +To run the Dialog modally, create the Dialog, and pass it to Run(Func<Exception, Boolean>). +This will execute the dialog until it terminates via the [ESC] or [CTRL-Q] key, or when one of the views +or buttons added to the dialog calls RequestStop(Toplevel). +
                                                      +

                                                      Constructors +

                                                      + +

                                                      Dialog()

                                                      +
                                                      +Initializes a new instance of the Dialog class using Computed. +
                                                      +
                                                      +
                                                      Declaration
                                                      +
                                                      + 
                                                      public Dialog()
                                                      +
                                                      +
                                                      Remarks
                                                      +
                                                      +

                                                      +Te Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. +After initialization use X, Y, Width, and Height to override this with a location or size. +

                                                      +

                                                      +Use AddButton(Button) to add buttons to the dialog. +

                                                      +
                                                      + +

                                                      Dialog(ustring, Int32, Int32, Button[])

                                                      +
                                                      +Initializes a new instance of the Dialog class using Computed positioning +and an optional set of Buttons to display +
                                                      +
                                                      +
                                                      Declaration
                                                      +
                                                      + 
                                                      public Dialog(ustring title, int width, int height, params Button[] buttons)
                                                      +
                                                      +
                                                      Parameters
                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                      TypeNameDescription
                                                      NStack.ustringtitleTitle for the dialog.
                                                      System.Int32widthWidth for the dialog.
                                                      System.Int32heightHeight for the dialog.
                                                      Button[]buttonsOptional buttons to lay out at the bottom of the dialog.
                                                      +
                                                      Remarks
                                                      +
                                                      +if width and height are both 0, the Dialog will be vertically and horizontally centered in the +container and the size will be 85% of the container. +After initialization use X, Y, Width, and Height to override this with a location or size. +
                                                      + +

                                                      Dialog(ustring, Button[])

                                                      +
                                                      +Initializes a new instance of the Dialog class using Computed positioning +and with an optional set of Buttons to display +
                                                      +
                                                      +
                                                      Declaration
                                                      +
                                                      + 
                                                      public Dialog(ustring title, params Button[] buttons)
                                                      +
                                                      +
                                                      Parameters
                                                      + + + + + + + + + + + + + + + + + + + + +
                                                      TypeNameDescription
                                                      NStack.ustringtitleTitle for the dialog.
                                                      Button[]buttonsOptional buttons to lay out at the bottom of the dialog.
                                                      +
                                                      Remarks
                                                      +
                                                      +Te Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. +After initialization use X, Y, Width, and Height to override this with a location or size. +
                                                      +

                                                      Properties +

                                                      + +

                                                      ButtonAlignment

                                                      +
                                                      +Determines how the Dialog Buttons are aligned along the +bottom of the dialog. +
                                                      +
                                                      +
                                                      Declaration
                                                      +
                                                      + 
                                                      public Dialog.ButtonAlignments ButtonAlignment { get; set; }
                                                      +
                                                      +
                                                      Property Value
                                                      + + + + + + + + + + + + + +
                                                      TypeDescription
                                                      Dialog.ButtonAlignments
                                                      +

                                                      Methods +

                                                      + +

                                                      AddButton(Button)

                                                      +
                                                      +Adds a Button to the Dialog, its layout will be controlled by the Dialog +
                                                      +
                                                      +
                                                      Declaration
                                                      +
                                                      + 
                                                      public void AddButton(Button button)
                                                      +
                                                      +
                                                      Parameters
                                                      + + + + + + + + + + + + + + + +
                                                      TypeNameDescription
                                                      ButtonbuttonButton to add.
                                                      + +

                                                      ProcessKey(KeyEvent)

                                                      +
                                                      +
                                                      +
                                                      Declaration
                                                      +
                                                      + 
                                                      public override bool ProcessKey(KeyEvent kb)
                                                      +
                                                      +
                                                      Parameters
                                                      + + + + + + + + + + + + + + + +
                                                      TypeNameDescription
                                                      KeyEventkb
                                                      +
                                                      Returns
                                                      + + + + + + + + + + + + + +
                                                      TypeDescription
                                                      System.Boolean
                                                      +
                                                      Overrides
                                                      + +

                                                      Implements

                                                      +
                                                      + System.IDisposable +
                                                      +
                                                      + System.ComponentModel.ISupportInitializeNotification +
                                                      +
                                                      + System.ComponentModel.ISupportInitialize +
                                                      +
                                                      +
                                                      + + +
                                                      +
                                                      + + +
                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Dim.html b/docs/api/Terminal.Gui/Terminal.Gui.Dim.html new file mode 100644 index 0000000000..17da74cfa2 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Dim.html @@ -0,0 +1,639 @@ + + + + + + + + Class Dim + + + + + + + + + + + + + + + + +
                                                      +
                                                      + + + +
                                                      + +
                                                      +
                                                      +
                                                      + +
                                                      +
                                                      Search Results for
                                                      +
                                                      +

                                                      +
                                                      +
                                                        +
                                                        +
                                                        +
                                                        + +
                                                        + +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        + + +

                                                        Class Dim +

                                                        +
                                                        +Dim properties of a View to control the position. +
                                                        +
                                                        +
                                                        +
                                                        Inheritance
                                                        +
                                                        System.Object
                                                        +
                                                        Dim
                                                        +
                                                        +
                                                        +
                                                        Inherited Members
                                                        +
                                                        + System.Object.Equals(System.Object, System.Object) +
                                                        +
                                                        + System.Object.GetType() +
                                                        +
                                                        + System.Object.MemberwiseClone() +
                                                        +
                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                        +
                                                        + System.Object.ToString() +
                                                        +
                                                        +
                                                        Namespace: Terminal.Gui
                                                        +
                                                        Assembly: Terminal.Gui.dll
                                                        +
                                                        Syntax
                                                        +
                                                        + 
                                                        public class Dim
                                                        +
                                                        +
                                                        Remarks
                                                        +
                                                        +

                                                        + Use the Dim objects on the Width or Height properties of a View to control the position. +

                                                        +

                                                        + These can be used to set the absolute position, when merely assigning an + integer value (via the implicit integer to Pos conversion), and they can be combined + to produce more useful layouts, like: Pos.Center - 3, which would shift the position + of the View 3 characters to the left after centering for example. +

                                                        +
                                                        +

                                                        Methods +

                                                        + +

                                                        Equals(Object)

                                                        +
                                                        Determines whether the specified object is equal to the current object.
                                                        +
                                                        +
                                                        Declaration
                                                        +
                                                        + 
                                                        public override bool Equals(object other)
                                                        +
                                                        +
                                                        Parameters
                                                        + + + + + + + + + + + + + + + +
                                                        TypeNameDescription
                                                        System.ObjectotherThe object to compare with the current object.
                                                        +
                                                        Returns
                                                        + + + + + + + + + + + + + +
                                                        TypeDescription
                                                        System.Boolean +true if the specified object is equal to the current object; otherwise, false.
                                                        +
                                                        Overrides
                                                        +
                                                        System.Object.Equals(System.Object)
                                                        + +

                                                        Fill(Int32)

                                                        +
                                                        +Initializes a new instance of the Dim class that fills the dimension, but leaves the specified number of colums for a margin. +
                                                        +
                                                        +
                                                        Declaration
                                                        +
                                                        + 
                                                        public static Dim Fill(int margin = 0)
                                                        +
                                                        +
                                                        Parameters
                                                        + + + + + + + + + + + + + + + +
                                                        TypeNameDescription
                                                        System.Int32marginMargin to use.
                                                        +
                                                        Returns
                                                        + + + + + + + + + + + + + +
                                                        TypeDescription
                                                        DimThe Fill dimension.
                                                        + +

                                                        Function(Func<Int32>)

                                                        +
                                                        +Creates a "DimFunc" from the specified function. +
                                                        +
                                                        +
                                                        Declaration
                                                        +
                                                        + 
                                                        public static Dim Function(Func<int> function)
                                                        +
                                                        +
                                                        Parameters
                                                        + + + + + + + + + + + + + + + +
                                                        TypeNameDescription
                                                        System.Func<System.Int32>functionThe function to be executed.
                                                        +
                                                        Returns
                                                        + + + + + + + + + + + + + +
                                                        TypeDescription
                                                        DimThe Dim returned from the function.
                                                        + +

                                                        GetHashCode()

                                                        +
                                                        Serves as the default hash function.
                                                        +
                                                        +
                                                        Declaration
                                                        +
                                                        + 
                                                        public override int GetHashCode()
                                                        +
                                                        +
                                                        Returns
                                                        + + + + + + + + + + + + + +
                                                        TypeDescription
                                                        System.Int32A hash code for the current object.
                                                        +
                                                        Overrides
                                                        +
                                                        System.Object.GetHashCode()
                                                        + +

                                                        Height(View)

                                                        +
                                                        +Returns a Dim object tracks the Height of the specified View. +
                                                        +
                                                        +
                                                        Declaration
                                                        +
                                                        + 
                                                        public static Dim Height(View view)
                                                        +
                                                        +
                                                        Parameters
                                                        + + + + + + + + + + + + + + + +
                                                        TypeNameDescription
                                                        ViewviewThe view that will be tracked.
                                                        +
                                                        Returns
                                                        + + + + + + + + + + + + + +
                                                        TypeDescription
                                                        DimThe Dim of the other View.
                                                        + +

                                                        Percent(Single, Boolean)

                                                        +
                                                        +Creates a percentage Dim object +
                                                        +
                                                        +
                                                        Declaration
                                                        +
                                                        + 
                                                        public static Dim Percent(float n, bool r = false)
                                                        +
                                                        +
                                                        Parameters
                                                        + + + + + + + + + + + + + + + + + + + + +
                                                        TypeNameDescription
                                                        System.SinglenA value between 0 and 100 representing the percentage.
                                                        System.BooleanrIf true the Percent is computed based on the remaining space after the X/Y anchor positions. If false is computed based on the whole original space.
                                                        +
                                                        Returns
                                                        + + + + + + + + + + + + + +
                                                        TypeDescription
                                                        DimThe percent Dim object.
                                                        +
                                                        Examples
                                                        + +This initializes a TextFieldthat is centered horizontally, is 50% of the way down, +is 30% the height, and is 80% the width of the View it added to. +
                                                        var textView = new TextView () {
+X = Pos.Center (),
+Y = Pos.Percent (50),
+Width = Dim.Percent (80),
+	Height = Dim.Percent (30),
+};
                                                        + + +

                                                        Sized(Int32)

                                                        +
                                                        +Creates an Absolute Dim from the specified integer value. +
                                                        +
                                                        +
                                                        Declaration
                                                        +
                                                        + 
                                                        public static Dim Sized(int n)
                                                        +
                                                        +
                                                        Parameters
                                                        + + + + + + + + + + + + + + + +
                                                        TypeNameDescription
                                                        System.Int32nThe value to convert to the Dim.
                                                        +
                                                        Returns
                                                        + + + + + + + + + + + + + +
                                                        TypeDescription
                                                        DimThe Absolute Dim.
                                                        + +

                                                        Width(View)

                                                        +
                                                        +Returns a Dim object tracks the Width of the specified View. +
                                                        +
                                                        +
                                                        Declaration
                                                        +
                                                        + 
                                                        public static Dim Width(View view)
                                                        +
                                                        +
                                                        Parameters
                                                        + + + + + + + + + + + + + + + +
                                                        TypeNameDescription
                                                        ViewviewThe view that will be tracked.
                                                        +
                                                        Returns
                                                        + + + + + + + + + + + + + +
                                                        TypeDescription
                                                        DimThe Dim of the other View.
                                                        +

                                                        Operators +

                                                        + +

                                                        Addition(Dim, Dim)

                                                        +
                                                        +Adds a Dim to a Dim, yielding a new Dim. +
                                                        +
                                                        +
                                                        Declaration
                                                        +
                                                        + 
                                                        public static Dim operator +(Dim left, Dim right)
                                                        +
                                                        +
                                                        Parameters
                                                        + + + + + + + + + + + + + + + + + + + + +
                                                        TypeNameDescription
                                                        DimleftThe first Dim to add.
                                                        DimrightThe second Dim to add.
                                                        +
                                                        Returns
                                                        + + + + + + + + + + + + + +
                                                        TypeDescription
                                                        DimThe Dim that is the sum of the values of left and right.
                                                        + +

                                                        Implicit(Int32 to Dim)

                                                        +
                                                        +Creates an Absolute Dim from the specified integer value. +
                                                        +
                                                        +
                                                        Declaration
                                                        +
                                                        + 
                                                        public static implicit operator Dim(int n)
                                                        +
                                                        +
                                                        Parameters
                                                        + + + + + + + + + + + + + + + +
                                                        TypeNameDescription
                                                        System.Int32nThe value to convert to the pos.
                                                        +
                                                        Returns
                                                        + + + + + + + + + + + + + +
                                                        TypeDescription
                                                        DimThe Absolute Dim.
                                                        + +

                                                        Subtraction(Dim, Dim)

                                                        +
                                                        +Subtracts a Dim from a Dim, yielding a new Dim. +
                                                        +
                                                        +
                                                        Declaration
                                                        +
                                                        + 
                                                        public static Dim operator -(Dim left, Dim right)
                                                        +
                                                        +
                                                        Parameters
                                                        + + + + + + + + + + + + + + + + + + + + +
                                                        TypeNameDescription
                                                        DimleftThe Dim to subtract from (the minuend).
                                                        DimrightThe Dim to subtract (the subtrahend).
                                                        +
                                                        Returns
                                                        + + + + + + + + + + + + + +
                                                        TypeDescription
                                                        DimThe Dim that is the left minus right.
                                                        +
                                                        +
                                                        + + +
                                                        +
                                                        + + +
                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.DisplayModeLayout.html b/docs/api/Terminal.Gui/Terminal.Gui.DisplayModeLayout.html new file mode 100644 index 0000000000..064bd8c9aa --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.DisplayModeLayout.html @@ -0,0 +1,152 @@ + + + + + + + + Enum DisplayModeLayout + + + + + + + + + + + + + + + + +
                                                        +
                                                        + + + +
                                                        + +
                                                        +
                                                        +
                                                        + +
                                                        +
                                                        Search Results for
                                                        +
                                                        +

                                                        +
                                                        +
                                                          +
                                                          +
                                                          +
                                                          + +
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          + + +

                                                          Enum DisplayModeLayout +

                                                          +
                                                          +Used for choose the display mode of this RadioGroup +
                                                          +
                                                          +
                                                          Namespace: Terminal.Gui
                                                          +
                                                          Assembly: Terminal.Gui.dll
                                                          +
                                                          Syntax
                                                          +
                                                          + 
                                                          public enum DisplayModeLayout
                                                          +
                                                          +

                                                          Fields +

                                                          + + + + + + + + + + + + + + + + + +
                                                          NameDescription
                                                          Horizontal +Horizontal mode display. +
                                                          Vertical +Vertical mode display. It's the default. +
                                                          +
                                                          +
                                                          + + +
                                                          +
                                                          + + +
                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.FakeConsole.html b/docs/api/Terminal.Gui/Terminal.Gui.FakeConsole.html new file mode 100644 index 0000000000..7153539b75 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.FakeConsole.html @@ -0,0 +1,2730 @@ + + + + + + + + Class FakeConsole + + + + + + + + + + + + + + + + +
                                                          +
                                                          + + + +
                                                          + +
                                                          +
                                                          +
                                                          + +
                                                          +
                                                          Search Results for
                                                          +
                                                          +

                                                          +
                                                          +
                                                            +
                                                            +
                                                            +
                                                            + +
                                                            + +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            + + +

                                                            Class FakeConsole +

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            +
                                                            Inheritance
                                                            +
                                                            System.Object
                                                            +
                                                            FakeConsole
                                                            +
                                                            +
                                                            +
                                                            Inherited Members
                                                            +
                                                            + System.Object.Equals(System.Object) +
                                                            +
                                                            + System.Object.Equals(System.Object, System.Object) +
                                                            +
                                                            + System.Object.GetHashCode() +
                                                            +
                                                            + System.Object.GetType() +
                                                            +
                                                            + System.Object.MemberwiseClone() +
                                                            +
                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                            +
                                                            + System.Object.ToString() +
                                                            +
                                                            +
                                                            Namespace: Terminal.Gui
                                                            +
                                                            Assembly: Terminal.Gui.dll
                                                            +
                                                            Syntax
                                                            +
                                                            + 
                                                            public static class FakeConsole
                                                            +
                                                            +

                                                            Fields +

                                                            +

                                                            HEIGHT

                                                            +
                                                            +Specifies the initial console height. +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public const int HEIGHT = 25
                                                            +
                                                            +
                                                            Field Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Int32
                                                            +

                                                            MockKeyPresses

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static Stack<ConsoleKeyInfo> MockKeyPresses
                                                            +
                                                            +
                                                            Field Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Collections.Generic.Stack<System.ConsoleKeyInfo>
                                                            +

                                                            WIDTH

                                                            +
                                                            +Specifies the initial console width. +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public const int WIDTH = 80
                                                            +
                                                            +
                                                            Field Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Int32
                                                            +

                                                            Properties +

                                                            + +

                                                            BackgroundColor

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static ConsoleColor BackgroundColor { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.ConsoleColor
                                                            + +

                                                            BufferHeight

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static int BufferHeight { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Int32
                                                            + +

                                                            BufferWidth

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static int BufferWidth { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Int32
                                                            + +

                                                            CapsLock

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static bool CapsLock { get; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Boolean
                                                            + +

                                                            CursorLeft

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static int CursorLeft { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Int32
                                                            + +

                                                            CursorSize

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static int CursorSize { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Int32
                                                            + +

                                                            CursorTop

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static int CursorTop { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Int32
                                                            + +

                                                            CursorVisible

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static bool CursorVisible { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Boolean
                                                            + +

                                                            Error

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static TextWriter Error { get; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.IO.TextWriter
                                                            + +

                                                            ForegroundColor

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static ConsoleColor ForegroundColor { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.ConsoleColor
                                                            + +

                                                            In

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static TextReader In { get; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.IO.TextReader
                                                            + +

                                                            InputEncoding

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static Encoding InputEncoding { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Text.Encoding
                                                            + +

                                                            IsErrorRedirected

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static bool IsErrorRedirected { get; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Boolean
                                                            + +

                                                            IsInputRedirected

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static bool IsInputRedirected { get; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Boolean
                                                            + +

                                                            IsOutputRedirected

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static bool IsOutputRedirected { get; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Boolean
                                                            + +

                                                            KeyAvailable

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static bool KeyAvailable { get; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Boolean
                                                            + +

                                                            LargestWindowHeight

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static int LargestWindowHeight { get; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Int32
                                                            + +

                                                            LargestWindowWidth

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static int LargestWindowWidth { get; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Int32
                                                            + +

                                                            NumberLock

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static bool NumberLock { get; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Boolean
                                                            + +

                                                            Out

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static TextWriter Out { get; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.IO.TextWriter
                                                            + +

                                                            OutputEncoding

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static Encoding OutputEncoding { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Text.Encoding
                                                            + +

                                                            Title

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static string Title { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.String
                                                            + +

                                                            TreatControlCAsInput

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static bool TreatControlCAsInput { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Boolean
                                                            + +

                                                            WindowHeight

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static int WindowHeight { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Int32
                                                            + +

                                                            WindowLeft

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static int WindowLeft { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Int32
                                                            + +

                                                            WindowTop

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static int WindowTop { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Int32
                                                            + +

                                                            WindowWidth

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static int WindowWidth { get; set; }
                                                            +
                                                            +
                                                            Property Value
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Int32
                                                            +

                                                            Methods +

                                                            + +

                                                            Beep()

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Beep()
                                                            +
                                                            + +

                                                            Beep(Int32, Int32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Beep(int frequency, int duration)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Int32frequency
                                                            System.Int32duration
                                                            + +

                                                            Clear()

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Clear()
                                                            +
                                                            + +

                                                            MoveBufferArea(Int32, Int32, Int32, Int32, Int32, Int32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void MoveBufferArea(int sourceLeft, int sourceTop, int sourceWidth, int sourceHeight, int targetLeft, int targetTop)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Int32sourceLeft
                                                            System.Int32sourceTop
                                                            System.Int32sourceWidth
                                                            System.Int32sourceHeight
                                                            System.Int32targetLeft
                                                            System.Int32targetTop
                                                            + +

                                                            MoveBufferArea(Int32, Int32, Int32, Int32, Int32, Int32, Char, ConsoleColor, ConsoleColor)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void MoveBufferArea(int sourceLeft, int sourceTop, int sourceWidth, int sourceHeight, int targetLeft, int targetTop, char sourceChar, ConsoleColor sourceForeColor, ConsoleColor sourceBackColor)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Int32sourceLeft
                                                            System.Int32sourceTop
                                                            System.Int32sourceWidth
                                                            System.Int32sourceHeight
                                                            System.Int32targetLeft
                                                            System.Int32targetTop
                                                            System.CharsourceChar
                                                            System.ConsoleColorsourceForeColor
                                                            System.ConsoleColorsourceBackColor
                                                            + +

                                                            OpenStandardError()

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static Stream OpenStandardError()
                                                            +
                                                            +
                                                            Returns
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.IO.Stream
                                                            + +

                                                            OpenStandardError(Int32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static Stream OpenStandardError(int bufferSize)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Int32bufferSize
                                                            +
                                                            Returns
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.IO.Stream
                                                            + +

                                                            OpenStandardInput()

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static Stream OpenStandardInput()
                                                            +
                                                            +
                                                            Returns
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.IO.Stream
                                                            + +

                                                            OpenStandardInput(Int32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static Stream OpenStandardInput(int bufferSize)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Int32bufferSize
                                                            +
                                                            Returns
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.IO.Stream
                                                            + +

                                                            OpenStandardOutput()

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static Stream OpenStandardOutput()
                                                            +
                                                            +
                                                            Returns
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.IO.Stream
                                                            + +

                                                            OpenStandardOutput(Int32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static Stream OpenStandardOutput(int bufferSize)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Int32bufferSize
                                                            +
                                                            Returns
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.IO.Stream
                                                            + +

                                                            Read()

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static int Read()
                                                            +
                                                            +
                                                            Returns
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.Int32
                                                            + +

                                                            ReadKey()

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static ConsoleKeyInfo ReadKey()
                                                            +
                                                            +
                                                            Returns
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.ConsoleKeyInfo
                                                            + +

                                                            ReadKey(Boolean)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static ConsoleKeyInfo ReadKey(bool intercept)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Booleanintercept
                                                            +
                                                            Returns
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.ConsoleKeyInfo
                                                            + +

                                                            ReadLine()

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static string ReadLine()
                                                            +
                                                            +
                                                            Returns
                                                            + + + + + + + + + + + + + +
                                                            TypeDescription
                                                            System.String
                                                            + +

                                                            ResetColor()

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void ResetColor()
                                                            +
                                                            + +

                                                            SetBufferSize(Int32, Int32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void SetBufferSize(int width, int height)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Int32width
                                                            System.Int32height
                                                            + +

                                                            SetCursorPosition(Int32, Int32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void SetCursorPosition(int left, int top)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Int32left
                                                            System.Int32top
                                                            + +

                                                            SetError(TextWriter)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void SetError(TextWriter newError)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.IO.TextWriternewError
                                                            + +

                                                            SetIn(TextReader)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void SetIn(TextReader newIn)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.IO.TextReadernewIn
                                                            + +

                                                            SetOut(TextWriter)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void SetOut(TextWriter newOut)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.IO.TextWriternewOut
                                                            + +

                                                            SetWindowPosition(Int32, Int32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void SetWindowPosition(int left, int top)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Int32left
                                                            System.Int32top
                                                            + +

                                                            SetWindowSize(Int32, Int32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void SetWindowSize(int width, int height)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Int32width
                                                            System.Int32height
                                                            + +

                                                            Write(Boolean)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(bool value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Booleanvalue
                                                            + +

                                                            Write(Char)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(char value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Charvalue
                                                            + +

                                                            Write(Char[])

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(char[] buffer)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Char[]buffer
                                                            + +

                                                            Write(Char[], Int32, Int32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(char[] buffer, int index, int count)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Char[]buffer
                                                            System.Int32index
                                                            System.Int32count
                                                            + +

                                                            Write(Decimal)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(decimal value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Decimalvalue
                                                            + +

                                                            Write(Double)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(double value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Doublevalue
                                                            + +

                                                            Write(Int32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(int value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Int32value
                                                            + +

                                                            Write(Int64)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(long value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Int64value
                                                            + +

                                                            Write(Object)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(object value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Objectvalue
                                                            + +

                                                            Write(Single)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(float value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Singlevalue
                                                            + +

                                                            Write(String)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(string value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Stringvalue
                                                            + +

                                                            Write(String, Object)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(string format, object arg0)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Stringformat
                                                            System.Objectarg0
                                                            + +

                                                            Write(String, Object, Object)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(string format, object arg0, object arg1)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Stringformat
                                                            System.Objectarg0
                                                            System.Objectarg1
                                                            + +

                                                            Write(String, Object, Object, Object)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(string format, object arg0, object arg1, object arg2)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Stringformat
                                                            System.Objectarg0
                                                            System.Objectarg1
                                                            System.Objectarg2
                                                            + +

                                                            Write(String, Object, Object, Object, Object)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(string format, object arg0, object arg1, object arg2, object arg3)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Stringformat
                                                            System.Objectarg0
                                                            System.Objectarg1
                                                            System.Objectarg2
                                                            System.Objectarg3
                                                            + +

                                                            Write(String, Object[])

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(string format, params object[] arg)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Stringformat
                                                            System.Object[]arg
                                                            + +

                                                            Write(UInt32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(uint value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.UInt32value
                                                            + +

                                                            Write(UInt64)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void Write(ulong value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.UInt64value
                                                            + +

                                                            WriteLine()

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine()
                                                            +
                                                            + +

                                                            WriteLine(Boolean)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(bool value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Booleanvalue
                                                            + +

                                                            WriteLine(Char)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(char value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Charvalue
                                                            + +

                                                            WriteLine(Char[])

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(char[] buffer)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Char[]buffer
                                                            + +

                                                            WriteLine(Char[], Int32, Int32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(char[] buffer, int index, int count)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Char[]buffer
                                                            System.Int32index
                                                            System.Int32count
                                                            + +

                                                            WriteLine(Decimal)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(decimal value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Decimalvalue
                                                            + +

                                                            WriteLine(Double)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(double value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Doublevalue
                                                            + +

                                                            WriteLine(Int32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(int value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Int32value
                                                            + +

                                                            WriteLine(Int64)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(long value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Int64value
                                                            + +

                                                            WriteLine(Object)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(object value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Objectvalue
                                                            + +

                                                            WriteLine(Single)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(float value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Singlevalue
                                                            + +

                                                            WriteLine(String)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(string value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Stringvalue
                                                            + +

                                                            WriteLine(String, Object)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(string format, object arg0)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Stringformat
                                                            System.Objectarg0
                                                            + +

                                                            WriteLine(String, Object, Object)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(string format, object arg0, object arg1)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Stringformat
                                                            System.Objectarg0
                                                            System.Objectarg1
                                                            + +

                                                            WriteLine(String, Object, Object, Object)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(string format, object arg0, object arg1, object arg2)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Stringformat
                                                            System.Objectarg0
                                                            System.Objectarg1
                                                            System.Objectarg2
                                                            + +

                                                            WriteLine(String, Object, Object, Object, Object)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(string format, object arg0, object arg1, object arg2, object arg3)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Stringformat
                                                            System.Objectarg0
                                                            System.Objectarg1
                                                            System.Objectarg2
                                                            System.Objectarg3
                                                            + +

                                                            WriteLine(String, Object[])

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(string format, params object[] arg)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.Stringformat
                                                            System.Object[]arg
                                                            + +

                                                            WriteLine(UInt32)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(uint value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.UInt32value
                                                            + +

                                                            WriteLine(UInt64)

                                                            +
                                                            + +
                                                            +
                                                            +
                                                            Declaration
                                                            +
                                                            + 
                                                            public static void WriteLine(ulong value)
                                                            +
                                                            +
                                                            Parameters
                                                            + + + + + + + + + + + + + + + +
                                                            TypeNameDescription
                                                            System.UInt64value
                                                            +
                                                            +
                                                            + + +
                                                            +
                                                            + + +
                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.FakeDriver.html b/docs/api/Terminal.Gui/Terminal.Gui.FakeDriver.html new file mode 100644 index 0000000000..0ac413fea5 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.FakeDriver.html @@ -0,0 +1,1221 @@ + + + + + + + + Class FakeDriver + + + + + + + + + + + + + + + + +
                                                            +
                                                            + + + +
                                                            + +
                                                            +
                                                            +
                                                            + +
                                                            +
                                                            Search Results for
                                                            +
                                                            +

                                                            +
                                                            +
                                                              +
                                                              +
                                                              +
                                                              + +
                                                              + +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              + + +

                                                              Class FakeDriver +

                                                              +
                                                              +Implements a mock ConsoleDriver for unit testing +
                                                              +
                                                              +
                                                              +
                                                              Inheritance
                                                              +
                                                              System.Object
                                                              +
                                                              ConsoleDriver
                                                              +
                                                              FakeDriver
                                                              +
                                                              +
                                                              +
                                                              Inherited Members
                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                              + System.Object.Equals(System.Object) +
                                                              +
                                                              + System.Object.Equals(System.Object, System.Object) +
                                                              +
                                                              + System.Object.GetHashCode() +
                                                              +
                                                              + System.Object.GetType() +
                                                              +
                                                              + System.Object.MemberwiseClone() +
                                                              +
                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                              +
                                                              + System.Object.ToString() +
                                                              +
                                                              +
                                                              Namespace: Terminal.Gui
                                                              +
                                                              Assembly: Terminal.Gui.dll
                                                              +
                                                              Syntax
                                                              +
                                                              + 
                                                              public class FakeDriver : ConsoleDriver
                                                              +
                                                              +

                                                              Constructors +

                                                              + +

                                                              FakeDriver()

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public FakeDriver()
                                                              +
                                                              +

                                                              Properties +

                                                              + +

                                                              Clipboard

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override IClipboard Clipboard { get; }
                                                              +
                                                              +
                                                              Property Value
                                                              + + + + + + + + + + + + + +
                                                              TypeDescription
                                                              IClipboard
                                                              +
                                                              Overrides
                                                              + + +

                                                              Cols

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override int Cols { get; }
                                                              +
                                                              +
                                                              Property Value
                                                              + + + + + + + + + + + + + +
                                                              TypeDescription
                                                              System.Int32
                                                              +
                                                              Overrides
                                                              + + +

                                                              Contents

                                                              +
                                                              +Assists with testing, the format is rows, columns and 3 values on the last column: Rune, Attribute and Dirty Flag +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override int[,, ] Contents { get; }
                                                              +
                                                              +
                                                              Property Value
                                                              + + + + + + + + + + + + + +
                                                              TypeDescription
                                                              System.Int32[,,]
                                                              +
                                                              Overrides
                                                              + + +

                                                              HeightAsBuffer

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override bool HeightAsBuffer { get; set; }
                                                              +
                                                              +
                                                              Property Value
                                                              + + + + + + + + + + + + + +
                                                              TypeDescription
                                                              System.Boolean
                                                              +
                                                              Overrides
                                                              + + +

                                                              Left

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override int Left { get; }
                                                              +
                                                              +
                                                              Property Value
                                                              + + + + + + + + + + + + + +
                                                              TypeDescription
                                                              System.Int32
                                                              +
                                                              Overrides
                                                              + + +

                                                              Rows

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override int Rows { get; }
                                                              +
                                                              +
                                                              Property Value
                                                              + + + + + + + + + + + + + +
                                                              TypeDescription
                                                              System.Int32
                                                              +
                                                              Overrides
                                                              + + +

                                                              Top

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override int Top { get; }
                                                              +
                                                              +
                                                              Property Value
                                                              + + + + + + + + + + + + + +
                                                              TypeDescription
                                                              System.Int32
                                                              +
                                                              Overrides
                                                              + +

                                                              Methods +

                                                              + +

                                                              AddRune(Rune)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void AddRune(Rune rune)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              System.Runerune
                                                              +
                                                              Overrides
                                                              + + +

                                                              AddStr(ustring)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void AddStr(ustring str)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              NStack.ustringstr
                                                              +
                                                              Overrides
                                                              + + +

                                                              CookMouse()

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void CookMouse()
                                                              +
                                                              +
                                                              Overrides
                                                              + + +

                                                              End()

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void End()
                                                              +
                                                              +
                                                              Overrides
                                                              + + +

                                                              EnsureCursorVisibility()

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override bool EnsureCursorVisibility()
                                                              +
                                                              +
                                                              Returns
                                                              + + + + + + + + + + + + + +
                                                              TypeDescription
                                                              System.Boolean
                                                              +
                                                              Overrides
                                                              + + +

                                                              GetAttribute()

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override Attribute GetAttribute()
                                                              +
                                                              +
                                                              Returns
                                                              + + + + + + + + + + + + + +
                                                              TypeDescription
                                                              Attribute
                                                              +
                                                              Overrides
                                                              + + +

                                                              GetColors(Int32, out Color, out Color)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override bool GetColors(int value, out Color foreground, out Color background)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              System.Int32value
                                                              Colorforeground
                                                              Colorbackground
                                                              +
                                                              Returns
                                                              + + + + + + + + + + + + + +
                                                              TypeDescription
                                                              System.Boolean
                                                              +
                                                              Overrides
                                                              + + +

                                                              GetCursorVisibility(out CursorVisibility)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override bool GetCursorVisibility(out CursorVisibility visibility)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              CursorVisibilityvisibility
                                                              +
                                                              Returns
                                                              + + + + + + + + + + + + + +
                                                              TypeDescription
                                                              System.Boolean
                                                              +
                                                              Overrides
                                                              + + +

                                                              Init(Action)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void Init(Action terminalResized)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              System.ActionterminalResized
                                                              +
                                                              Overrides
                                                              + + +

                                                              MakeAttribute(Color, Color)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override Attribute MakeAttribute(Color fore, Color back)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              Colorfore
                                                              Colorback
                                                              +
                                                              Returns
                                                              + + + + + + + + + + + + + +
                                                              TypeDescription
                                                              Attribute
                                                              +
                                                              Overrides
                                                              + + +

                                                              Move(Int32, Int32)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void Move(int col, int row)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              System.Int32col
                                                              System.Int32row
                                                              +
                                                              Overrides
                                                              + + +

                                                              PrepareToRun(MainLoop, Action<KeyEvent>, Action<KeyEvent>, Action<KeyEvent>, Action<MouseEvent>)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void PrepareToRun(MainLoop mainLoop, Action<KeyEvent> keyHandler, Action<KeyEvent> keyDownHandler, Action<KeyEvent> keyUpHandler, Action<MouseEvent> mouseHandler)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              MainLoopmainLoop
                                                              System.Action<KeyEvent>keyHandler
                                                              System.Action<KeyEvent>keyDownHandler
                                                              System.Action<KeyEvent>keyUpHandler
                                                              System.Action<MouseEvent>mouseHandler
                                                              +
                                                              Overrides
                                                              + + +

                                                              Refresh()

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void Refresh()
                                                              +
                                                              +
                                                              Overrides
                                                              + + +

                                                              ResizeScreen()

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void ResizeScreen()
                                                              +
                                                              +
                                                              Overrides
                                                              + + +

                                                              SendKeys(Char, ConsoleKey, Boolean, Boolean, Boolean)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void SendKeys(char keyChar, ConsoleKey key, bool shift, bool alt, bool control)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              System.CharkeyChar
                                                              System.ConsoleKeykey
                                                              System.Booleanshift
                                                              System.Booleanalt
                                                              System.Booleancontrol
                                                              +
                                                              Overrides
                                                              + + +

                                                              SetAttribute(Attribute)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void SetAttribute(Attribute c)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              Attributec
                                                              +
                                                              Overrides
                                                              + + +

                                                              SetBufferSize(Int32, Int32)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public void SetBufferSize(int width, int height)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              System.Int32width
                                                              System.Int32height
                                                              + +

                                                              SetColors(ConsoleColor, ConsoleColor)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void SetColors(ConsoleColor foreground, ConsoleColor background)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              System.ConsoleColorforeground
                                                              System.ConsoleColorbackground
                                                              +
                                                              Overrides
                                                              + + +

                                                              SetColors(Int16, Int16)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void SetColors(short foregroundColorId, short backgroundColorId)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              System.Int16foregroundColorId
                                                              System.Int16backgroundColorId
                                                              +
                                                              Overrides
                                                              + + +

                                                              SetCursorVisibility(CursorVisibility)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override bool SetCursorVisibility(CursorVisibility visibility)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              CursorVisibilityvisibility
                                                              +
                                                              Returns
                                                              + + + + + + + + + + + + + +
                                                              TypeDescription
                                                              System.Boolean
                                                              +
                                                              Overrides
                                                              + + +

                                                              SetWindowPosition(Int32, Int32)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public void SetWindowPosition(int left, int top)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              System.Int32left
                                                              System.Int32top
                                                              + +

                                                              SetWindowSize(Int32, Int32)

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public void SetWindowSize(int width, int height)
                                                              +
                                                              +
                                                              Parameters
                                                              + + + + + + + + + + + + + + + + + + + + +
                                                              TypeNameDescription
                                                              System.Int32width
                                                              System.Int32height
                                                              + +

                                                              StartReportingMouseMoves()

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void StartReportingMouseMoves()
                                                              +
                                                              +
                                                              Overrides
                                                              + + +

                                                              StopReportingMouseMoves()

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void StopReportingMouseMoves()
                                                              +
                                                              +
                                                              Overrides
                                                              + + +

                                                              Suspend()

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void Suspend()
                                                              +
                                                              +
                                                              Overrides
                                                              + + +

                                                              UncookMouse()

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void UncookMouse()
                                                              +
                                                              +
                                                              Overrides
                                                              + + +

                                                              UpdateCursor()

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void UpdateCursor()
                                                              +
                                                              +
                                                              Overrides
                                                              + + +

                                                              UpdateOffScreen()

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void UpdateOffScreen()
                                                              +
                                                              +
                                                              Overrides
                                                              + + +

                                                              UpdateScreen()

                                                              +
                                                              +
                                                              +
                                                              Declaration
                                                              +
                                                              + 
                                                              public override void UpdateScreen()
                                                              +
                                                              +
                                                              Overrides
                                                              + +
                                                              +
                                                              + + +
                                                              +
                                                              + + +
                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.FakeMainLoop.html b/docs/api/Terminal.Gui/Terminal.Gui.FakeMainLoop.html new file mode 100644 index 0000000000..3f9ce72c7d --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.FakeMainLoop.html @@ -0,0 +1,313 @@ + + + + + + + + Class FakeMainLoop + + + + + + + + + + + + + + + + +
                                                              +
                                                              + + + +
                                                              + +
                                                              +
                                                              +
                                                              + +
                                                              +
                                                              Search Results for
                                                              +
                                                              +

                                                              +
                                                              +
                                                                +
                                                                +
                                                                +
                                                                + +
                                                                + +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                + + +

                                                                Class FakeMainLoop +

                                                                +
                                                                +Mainloop intended to be used with the .NET System.Console API, and can +be used on Windows and Unix, it is cross platform but lacks things like +file descriptor monitoring. +
                                                                +
                                                                +
                                                                +
                                                                Inheritance
                                                                +
                                                                System.Object
                                                                +
                                                                FakeMainLoop
                                                                +
                                                                +
                                                                +
                                                                Implements
                                                                + +
                                                                +
                                                                +
                                                                Inherited Members
                                                                +
                                                                + System.Object.Equals(System.Object) +
                                                                +
                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                +
                                                                + System.Object.GetHashCode() +
                                                                +
                                                                + System.Object.GetType() +
                                                                +
                                                                + System.Object.MemberwiseClone() +
                                                                +
                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                +
                                                                + System.Object.ToString() +
                                                                +
                                                                +
                                                                Namespace: Terminal.Gui
                                                                +
                                                                Assembly: Terminal.Gui.dll
                                                                +
                                                                Syntax
                                                                +
                                                                + 
                                                                public class FakeMainLoop : IMainLoopDriver
                                                                +
                                                                +
                                                                Remarks
                                                                +
                                                                +This implementation is used for FakeDriver. +
                                                                +

                                                                Constructors +

                                                                + +

                                                                FakeMainLoop(Func<ConsoleKeyInfo>)

                                                                +
                                                                +Initializes the class. +
                                                                +
                                                                +
                                                                Declaration
                                                                +
                                                                + 
                                                                public FakeMainLoop(Func<ConsoleKeyInfo> consoleKeyReaderFn = null)
                                                                +
                                                                +
                                                                Parameters
                                                                + + + + + + + + + + + + + + + +
                                                                TypeNameDescription
                                                                System.Func<System.ConsoleKeyInfo>consoleKeyReaderFnThe method to be called to get a key from the console.
                                                                +
                                                                Remarks
                                                                +
                                                                +Passing a consoleKeyReaderfn is provided to support unit test scenarios. +
                                                                +

                                                                Fields +

                                                                +

                                                                KeyPressed

                                                                +
                                                                +Invoked when a Key is pressed. +
                                                                +
                                                                +
                                                                Declaration
                                                                +
                                                                + 
                                                                public Action<ConsoleKeyInfo> KeyPressed
                                                                +
                                                                +
                                                                Field Value
                                                                + + + + + + + + + + + + + +
                                                                TypeDescription
                                                                System.Action<System.ConsoleKeyInfo>
                                                                +

                                                                Explicit Interface Implementations +

                                                                + +

                                                                IMainLoopDriver.EventsPending(Boolean)

                                                                +
                                                                +
                                                                +
                                                                Declaration
                                                                +
                                                                + 
                                                                bool IMainLoopDriver.EventsPending(bool wait)
                                                                +
                                                                +
                                                                Parameters
                                                                + + + + + + + + + + + + + + + +
                                                                TypeNameDescription
                                                                System.Booleanwait
                                                                +
                                                                Returns
                                                                + + + + + + + + + + + + + +
                                                                TypeDescription
                                                                System.Boolean
                                                                + +

                                                                IMainLoopDriver.MainIteration()

                                                                +
                                                                +
                                                                +
                                                                Declaration
                                                                +
                                                                + 
                                                                void IMainLoopDriver.MainIteration()
                                                                +
                                                                + +

                                                                IMainLoopDriver.Setup(MainLoop)

                                                                +
                                                                +
                                                                +
                                                                Declaration
                                                                +
                                                                + 
                                                                void IMainLoopDriver.Setup(MainLoop mainLoop)
                                                                +
                                                                +
                                                                Parameters
                                                                + + + + + + + + + + + + + + + +
                                                                TypeNameDescription
                                                                MainLoopmainLoop
                                                                + +

                                                                IMainLoopDriver.Wakeup()

                                                                +
                                                                +
                                                                +
                                                                Declaration
                                                                +
                                                                + 
                                                                void IMainLoopDriver.Wakeup()
                                                                +
                                                                +

                                                                Implements

                                                                + +
                                                                +
                                                                + + +
                                                                +
                                                                + + +
                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.FileDialog.html b/docs/api/Terminal.Gui/Terminal.Gui.FileDialog.html new file mode 100644 index 0000000000..546d79143b --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.FileDialog.html @@ -0,0 +1,1159 @@ + + + + + + + + Class FileDialog + + + + + + + + + + + + + + + + +
                                                                +
                                                                + + + +
                                                                + +
                                                                +
                                                                +
                                                                + +
                                                                +
                                                                Search Results for
                                                                +
                                                                +

                                                                +
                                                                +
                                                                  +
                                                                  +
                                                                  +
                                                                  + +
                                                                  + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +

                                                                  Class FileDialog +

                                                                  +
                                                                  +Base class for the OpenDialog and the SaveDialog +
                                                                  +
                                                                  +
                                                                  +
                                                                  Inheritance
                                                                  +
                                                                  System.Object
                                                                  +
                                                                  Responder
                                                                  +
                                                                  View
                                                                  +
                                                                  Toplevel
                                                                  +
                                                                  Window
                                                                  +
                                                                  Dialog
                                                                  +
                                                                  FileDialog
                                                                  +
                                                                  OpenDialog
                                                                  +
                                                                  SaveDialog
                                                                  +
                                                                  +
                                                                  +
                                                                  Implements
                                                                  +
                                                                  System.IDisposable
                                                                  +
                                                                  System.ComponentModel.ISupportInitializeNotification
                                                                  +
                                                                  System.ComponentModel.ISupportInitialize
                                                                  +
                                                                  +
                                                                  +
                                                                  Inherited Members
                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                  + View.Data +
                                                                  + + + + + +
                                                                  + View.Id +
                                                                  + + + + + + +
                                                                  + View.X +
                                                                  +
                                                                  + View.Y +
                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                  + System.Object.Equals(System.Object) +
                                                                  +
                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                  +
                                                                  + System.Object.GetHashCode() +
                                                                  +
                                                                  + System.Object.GetType() +
                                                                  +
                                                                  + System.Object.MemberwiseClone() +
                                                                  +
                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                  +
                                                                  +
                                                                  Namespace: Terminal.Gui
                                                                  +
                                                                  Assembly: Terminal.Gui.dll
                                                                  +
                                                                  Syntax
                                                                  +
                                                                  + 
                                                                  public class FileDialog : Dialog, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                  +
                                                                  +

                                                                  Constructors +

                                                                  + +

                                                                  FileDialog()

                                                                  +
                                                                  +Initializes a new FileDialog. +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public FileDialog()
                                                                  +
                                                                  + +

                                                                  FileDialog(ustring, ustring, ustring, ustring, ustring, List<String>)

                                                                  +
                                                                  +Initializes a new instance of FileDialog +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public FileDialog(ustring title, ustring prompt, ustring nameDirLabel, ustring nameFieldLabel, ustring message, List<string> allowedTypes = null)
                                                                  +
                                                                  +
                                                                  Parameters
                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                  TypeNameDescription
                                                                  NStack.ustringtitleThe title.
                                                                  NStack.ustringpromptThe prompt.
                                                                  NStack.ustringnameDirLabelThe name of the directory field label.
                                                                  NStack.ustringnameFieldLabelThe name of the file field label..
                                                                  NStack.ustringmessageThe message.
                                                                  System.Collections.Generic.List<System.String>allowedTypesThe allowed types.
                                                                  + +

                                                                  FileDialog(ustring, ustring, ustring, ustring, List<String>)

                                                                  +
                                                                  +Initializes a new instance of FileDialog +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public FileDialog(ustring title, ustring prompt, ustring nameFieldLabel, ustring message, List<string> allowedTypes = null)
                                                                  +
                                                                  +
                                                                  Parameters
                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                  TypeNameDescription
                                                                  NStack.ustringtitleThe title.
                                                                  NStack.ustringpromptThe prompt.
                                                                  NStack.ustringnameFieldLabelThe name of the file field label..
                                                                  NStack.ustringmessageThe message.
                                                                  System.Collections.Generic.List<System.String>allowedTypesThe allowed types.
                                                                  + +

                                                                  FileDialog(ustring, ustring, ustring, List<String>)

                                                                  +
                                                                  +Initializes a new instance of FileDialog +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public FileDialog(ustring title, ustring prompt, ustring message, List<string> allowedTypes)
                                                                  +
                                                                  +
                                                                  Parameters
                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                  TypeNameDescription
                                                                  NStack.ustringtitleThe title.
                                                                  NStack.ustringpromptThe prompt.
                                                                  NStack.ustringmessageThe message.
                                                                  System.Collections.Generic.List<System.String>allowedTypesThe allowed types.
                                                                  +

                                                                  Properties +

                                                                  + +

                                                                  AllowedFileTypes

                                                                  +
                                                                  +The array of filename extensions allowed, or null if all file extensions are allowed. +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public string[] AllowedFileTypes { get; set; }
                                                                  +
                                                                  +
                                                                  Property Value
                                                                  + + + + + + + + + + + + + +
                                                                  TypeDescription
                                                                  System.String[]The allowed file types.
                                                                  + +

                                                                  AllowsOtherFileTypes

                                                                  +
                                                                  +Gets or sets a value indicating whether this FileDialog allows the file to be saved with a different extension +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public bool AllowsOtherFileTypes { get; set; }
                                                                  +
                                                                  +
                                                                  Property Value
                                                                  + + + + + + + + + + + + + +
                                                                  TypeDescription
                                                                  System.Booleantrue if allows other file types; otherwise, false.
                                                                  + +

                                                                  Canceled

                                                                  +
                                                                  +Check if the dialog was or not canceled. +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public bool Canceled { get; }
                                                                  +
                                                                  +
                                                                  Property Value
                                                                  + + + + + + + + + + + + + +
                                                                  TypeDescription
                                                                  System.Boolean
                                                                  + +

                                                                  CanCreateDirectories

                                                                  +
                                                                  +Gets or sets a value indicating whether this FileDialog can create directories. +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public bool CanCreateDirectories { get; set; }
                                                                  +
                                                                  +
                                                                  Property Value
                                                                  + + + + + + + + + + + + + +
                                                                  TypeDescription
                                                                  System.Booleantrue if can create directories; otherwise, false.
                                                                  + +

                                                                  DirectoryPath

                                                                  +
                                                                  +Gets or sets the directory path for this panel +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public ustring DirectoryPath { get; set; }
                                                                  +
                                                                  +
                                                                  Property Value
                                                                  + + + + + + + + + + + + + +
                                                                  TypeDescription
                                                                  NStack.ustringThe directory path.
                                                                  + +

                                                                  FilePath

                                                                  +
                                                                  +The File path that is currently shown on the panel +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public ustring FilePath { get; set; }
                                                                  +
                                                                  +
                                                                  Property Value
                                                                  + + + + + + + + + + + + + +
                                                                  TypeDescription
                                                                  NStack.ustringThe absolute file path for the file path entered.
                                                                  + +

                                                                  IsExtensionHidden

                                                                  +
                                                                  +Gets or sets a value indicating whether this FileDialog is extension hidden. +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public bool IsExtensionHidden { get; set; }
                                                                  +
                                                                  +
                                                                  Property Value
                                                                  + + + + + + + + + + + + + +
                                                                  TypeDescription
                                                                  System.Booleantrue if is extension hidden; otherwise, false.
                                                                  + +

                                                                  Message

                                                                  +
                                                                  +Gets or sets the message displayed to the user, defaults to nothing +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public ustring Message { get; set; }
                                                                  +
                                                                  +
                                                                  Property Value
                                                                  + + + + + + + + + + + + + +
                                                                  TypeDescription
                                                                  NStack.ustringThe message.
                                                                  + +

                                                                  NameDirLabel

                                                                  +
                                                                  +Gets or sets the name of the directory field label. +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public ustring NameDirLabel { get; set; }
                                                                  +
                                                                  +
                                                                  Property Value
                                                                  + + + + + + + + + + + + + +
                                                                  TypeDescription
                                                                  NStack.ustringThe name of the directory field label.
                                                                  + +

                                                                  NameFieldLabel

                                                                  +
                                                                  +Gets or sets the name field label. +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public ustring NameFieldLabel { get; set; }
                                                                  +
                                                                  +
                                                                  Property Value
                                                                  + + + + + + + + + + + + + +
                                                                  TypeDescription
                                                                  NStack.ustringThe name field label.
                                                                  + +

                                                                  Prompt

                                                                  +
                                                                  +Gets or sets the prompt label for the Button displayed to the user +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public ustring Prompt { get; set; }
                                                                  +
                                                                  +
                                                                  Property Value
                                                                  + + + + + + + + + + + + + +
                                                                  TypeDescription
                                                                  NStack.ustringThe prompt.
                                                                  +

                                                                  Methods +

                                                                  + +

                                                                  WillPresent()

                                                                  +
                                                                  +
                                                                  +
                                                                  Declaration
                                                                  +
                                                                  + 
                                                                  public override void WillPresent()
                                                                  +
                                                                  +
                                                                  Overrides
                                                                  + +

                                                                  Implements

                                                                  +
                                                                  + System.IDisposable +
                                                                  +
                                                                  + System.ComponentModel.ISupportInitializeNotification +
                                                                  +
                                                                  + System.ComponentModel.ISupportInitialize +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  +
                                                                  + + +
                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.FrameView.html b/docs/api/Terminal.Gui/Terminal.Gui.FrameView.html new file mode 100644 index 0000000000..9cad586b02 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.FrameView.html @@ -0,0 +1,916 @@ + + + + + + + + Class FrameView + + + + + + + + + + + + + + + + +
                                                                  +
                                                                  + + + +
                                                                  + +
                                                                  +
                                                                  +
                                                                  + +
                                                                  +
                                                                  Search Results for
                                                                  +
                                                                  +

                                                                  +
                                                                  +
                                                                    +
                                                                    +
                                                                    +
                                                                    + +
                                                                    + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    + + +

                                                                    Class FrameView +

                                                                    +
                                                                    +The FrameView is a container frame that draws a frame around the contents. It is similar to +a GroupBox in Windows. +
                                                                    +
                                                                    +
                                                                    +
                                                                    Inheritance
                                                                    +
                                                                    System.Object
                                                                    +
                                                                    Responder
                                                                    +
                                                                    View
                                                                    +
                                                                    FrameView
                                                                    +
                                                                    Wizard.WizardStep
                                                                    +
                                                                    +
                                                                    +
                                                                    Implements
                                                                    +
                                                                    System.IDisposable
                                                                    +
                                                                    System.ComponentModel.ISupportInitializeNotification
                                                                    +
                                                                    System.ComponentModel.ISupportInitialize
                                                                    +
                                                                    +
                                                                    +
                                                                    Inherited Members
                                                                    + + + + + + + + + + + + + + + + +
                                                                    + View.Data +
                                                                    + + + + + + +
                                                                    + View.Id +
                                                                    + + + + + + +
                                                                    + View.X +
                                                                    +
                                                                    + View.Y +
                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                    + System.Object.Equals(System.Object) +
                                                                    +
                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                    +
                                                                    + System.Object.GetHashCode() +
                                                                    +
                                                                    + System.Object.GetType() +
                                                                    +
                                                                    + System.Object.MemberwiseClone() +
                                                                    +
                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                    +
                                                                    +
                                                                    Namespace: Terminal.Gui
                                                                    +
                                                                    Assembly: Terminal.Gui.dll
                                                                    +
                                                                    Syntax
                                                                    +
                                                                    + 
                                                                    public class FrameView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                    +
                                                                    +

                                                                    Constructors +

                                                                    + +

                                                                    FrameView()

                                                                    +
                                                                    +Initializes a new instance of the FrameView class using Computed layout. +
                                                                    +
                                                                    +
                                                                    Declaration
                                                                    +
                                                                    + 
                                                                    public FrameView()
                                                                    +
                                                                    + +

                                                                    FrameView(ustring, Border)

                                                                    +
                                                                    +Initializes a new instance of the FrameView class using Computed layout. +
                                                                    +
                                                                    +
                                                                    Declaration
                                                                    +
                                                                    + 
                                                                    public FrameView(ustring title, Border border = null)
                                                                    +
                                                                    +
                                                                    Parameters
                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                    TypeNameDescription
                                                                    NStack.ustringtitleTitle.
                                                                    BorderborderThe Border.
                                                                    + +

                                                                    FrameView(Rect, ustring, View[], Border)

                                                                    +
                                                                    +Initializes a new instance of the FrameView class using Absolute layout. +
                                                                    +
                                                                    +
                                                                    Declaration
                                                                    +
                                                                    + 
                                                                    public FrameView(Rect frame, ustring title = null, View[] views = null, Border border = null)
                                                                    +
                                                                    +
                                                                    Parameters
                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                    TypeNameDescription
                                                                    RectframeFrame.
                                                                    NStack.ustringtitleTitle.
                                                                    View[]viewsViews.
                                                                    BorderborderThe Border.
                                                                    +

                                                                    Properties +

                                                                    + +

                                                                    Border

                                                                    +
                                                                    +
                                                                    +
                                                                    Declaration
                                                                    +
                                                                    + 
                                                                    public override Border Border { get; set; }
                                                                    +
                                                                    +
                                                                    Property Value
                                                                    + + + + + + + + + + + + + +
                                                                    TypeDescription
                                                                    Border
                                                                    +
                                                                    Overrides
                                                                    + + +

                                                                    Text

                                                                    +
                                                                    +The text displayed by the Label. +
                                                                    +
                                                                    +
                                                                    Declaration
                                                                    +
                                                                    + 
                                                                    public override ustring Text { get; set; }
                                                                    +
                                                                    +
                                                                    Property Value
                                                                    + + + + + + + + + + + + + +
                                                                    TypeDescription
                                                                    NStack.ustring
                                                                    +
                                                                    Overrides
                                                                    + + +

                                                                    TextAlignment

                                                                    +
                                                                    +Controls the text-alignment property of the label, changing it will redisplay the Label. +
                                                                    +
                                                                    +
                                                                    Declaration
                                                                    +
                                                                    + 
                                                                    public override TextAlignment TextAlignment { get; set; }
                                                                    +
                                                                    +
                                                                    Property Value
                                                                    + + + + + + + + + + + + + +
                                                                    TypeDescription
                                                                    TextAlignmentThe text alignment.
                                                                    +
                                                                    Overrides
                                                                    + + +

                                                                    Title

                                                                    +
                                                                    +The title to be displayed for this FrameView. +
                                                                    +
                                                                    +
                                                                    Declaration
                                                                    +
                                                                    + 
                                                                    public ustring Title { get; set; }
                                                                    +
                                                                    +
                                                                    Property Value
                                                                    + + + + + + + + + + + + + +
                                                                    TypeDescription
                                                                    NStack.ustringThe title.
                                                                    +

                                                                    Methods +

                                                                    + +

                                                                    Add(View)

                                                                    +
                                                                    +Add the specified View to this container. +
                                                                    +
                                                                    +
                                                                    Declaration
                                                                    +
                                                                    + 
                                                                    public override void Add(View view)
                                                                    +
                                                                    +
                                                                    Parameters
                                                                    + + + + + + + + + + + + + + + +
                                                                    TypeNameDescription
                                                                    ViewviewView to add to this container
                                                                    +
                                                                    Overrides
                                                                    + + +

                                                                    OnCanFocusChanged()

                                                                    +
                                                                    +
                                                                    +
                                                                    Declaration
                                                                    +
                                                                    + 
                                                                    public override void OnCanFocusChanged()
                                                                    +
                                                                    +
                                                                    Overrides
                                                                    + + +

                                                                    OnEnter(View)

                                                                    +
                                                                    +
                                                                    +
                                                                    Declaration
                                                                    +
                                                                    + 
                                                                    public override bool OnEnter(View view)
                                                                    +
                                                                    +
                                                                    Parameters
                                                                    + + + + + + + + + + + + + + + +
                                                                    TypeNameDescription
                                                                    Viewview
                                                                    +
                                                                    Returns
                                                                    + + + + + + + + + + + + + +
                                                                    TypeDescription
                                                                    System.Boolean
                                                                    +
                                                                    Overrides
                                                                    + + +

                                                                    Redraw(Rect)

                                                                    +
                                                                    +
                                                                    +
                                                                    Declaration
                                                                    +
                                                                    + 
                                                                    public override void Redraw(Rect bounds)
                                                                    +
                                                                    +
                                                                    Parameters
                                                                    + + + + + + + + + + + + + + + +
                                                                    TypeNameDescription
                                                                    Rectbounds
                                                                    +
                                                                    Overrides
                                                                    + + +

                                                                    Remove(View)

                                                                    +
                                                                    +Removes a View from this container. +
                                                                    +
                                                                    +
                                                                    Declaration
                                                                    +
                                                                    + 
                                                                    public override void Remove(View view)
                                                                    +
                                                                    +
                                                                    Parameters
                                                                    + + + + + + + + + + + + + + + +
                                                                    TypeNameDescription
                                                                    Viewview
                                                                    +
                                                                    Overrides
                                                                    + +
                                                                    Remarks
                                                                    +
                                                                    +
                                                                    + +

                                                                    RemoveAll()

                                                                    +
                                                                    +Removes all Views from this container. +
                                                                    +
                                                                    +
                                                                    Declaration
                                                                    +
                                                                    + 
                                                                    public override void RemoveAll()
                                                                    +
                                                                    +
                                                                    Overrides
                                                                    + +
                                                                    Remarks
                                                                    +
                                                                    +
                                                                    +

                                                                    Implements

                                                                    +
                                                                    + System.IDisposable +
                                                                    +
                                                                    + System.ComponentModel.ISupportInitializeNotification +
                                                                    +
                                                                    + System.ComponentModel.ISupportInitialize +
                                                                    +
                                                                    +
                                                                    + + +
                                                                    +
                                                                    + + +
                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.GraphView.html b/docs/api/Terminal.Gui/Terminal.Gui.GraphView.html new file mode 100644 index 0000000000..93edade801 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.GraphView.html @@ -0,0 +1,1147 @@ + + + + + + + + Class GraphView + + + + + + + + + + + + + + + + +
                                                                    +
                                                                    + + + +
                                                                    + +
                                                                    +
                                                                    +
                                                                    + +
                                                                    +
                                                                    Search Results for
                                                                    +
                                                                    +

                                                                    +
                                                                    +
                                                                      +
                                                                      +
                                                                      +
                                                                      + +
                                                                      + +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      + + +

                                                                      Class GraphView +

                                                                      +
                                                                      +Control for rendering graphs (bar, scatter etc) +
                                                                      +
                                                                      +
                                                                      +
                                                                      Inheritance
                                                                      +
                                                                      System.Object
                                                                      +
                                                                      Responder
                                                                      +
                                                                      View
                                                                      +
                                                                      GraphView
                                                                      +
                                                                      +
                                                                      +
                                                                      Implements
                                                                      +
                                                                      System.IDisposable
                                                                      +
                                                                      System.ComponentModel.ISupportInitializeNotification
                                                                      +
                                                                      System.ComponentModel.ISupportInitialize
                                                                      +
                                                                      +
                                                                      +
                                                                      Inherited Members
                                                                      + + + + + + + + + + + + + + + + +
                                                                      + View.Data +
                                                                      + + + + + + +
                                                                      + View.Id +
                                                                      + + + + + + +
                                                                      + View.X +
                                                                      +
                                                                      + View.Y +
                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                      + View.Text +
                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                      + System.Object.Equals(System.Object) +
                                                                      +
                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                      +
                                                                      + System.Object.GetHashCode() +
                                                                      +
                                                                      + System.Object.GetType() +
                                                                      +
                                                                      + System.Object.MemberwiseClone() +
                                                                      +
                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                      +
                                                                      +
                                                                      Namespace: Terminal.Gui
                                                                      +
                                                                      Assembly: Terminal.Gui.dll
                                                                      +
                                                                      Syntax
                                                                      +
                                                                      + 
                                                                      public class GraphView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                      +
                                                                      +

                                                                      Constructors +

                                                                      + +

                                                                      GraphView()

                                                                      +
                                                                      +Creates a new graph with a 1 to 1 graph space with absolute layout +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public GraphView()
                                                                      +
                                                                      +

                                                                      Properties +

                                                                      + +

                                                                      Annotations

                                                                      +
                                                                      +Elements drawn into graph after series have been drawn e.g. Legends etc +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public List<IAnnotation> Annotations { get; }
                                                                      +
                                                                      +
                                                                      Property Value
                                                                      + + + + + + + + + + + + + +
                                                                      TypeDescription
                                                                      System.Collections.Generic.List<IAnnotation>
                                                                      + +

                                                                      AxisX

                                                                      +
                                                                      +Horizontal axis +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public HorizontalAxis AxisX { get; set; }
                                                                      +
                                                                      +
                                                                      Property Value
                                                                      + + + + + + + + + + + + + +
                                                                      TypeDescription
                                                                      HorizontalAxis
                                                                      + +

                                                                      AxisY

                                                                      +
                                                                      +Vertical axis +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public VerticalAxis AxisY { get; set; }
                                                                      +
                                                                      +
                                                                      Property Value
                                                                      + + + + + + + + + + + + + +
                                                                      TypeDescription
                                                                      VerticalAxis
                                                                      + +

                                                                      CellSize

                                                                      +
                                                                      +Translates console width/height into graph space. Defaults +to 1 row/col of console space being 1 unit of graph space. +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public PointF CellSize { get; set; }
                                                                      +
                                                                      +
                                                                      Property Value
                                                                      + + + + + + + + + + + + + +
                                                                      TypeDescription
                                                                      PointF
                                                                      + +

                                                                      GraphColor

                                                                      +
                                                                      +The color of the background of the graph and axis/labels +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public Attribute? GraphColor { get; set; }
                                                                      +
                                                                      +
                                                                      Property Value
                                                                      + + + + + + + + + + + + + +
                                                                      TypeDescription
                                                                      System.Nullable<Attribute>
                                                                      + +

                                                                      MarginBottom

                                                                      +
                                                                      +Amount of space to leave on bottom of control. Graph content (Series) +will not be rendered in margins but axis labels may be +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public uint MarginBottom { get; set; }
                                                                      +
                                                                      +
                                                                      Property Value
                                                                      + + + + + + + + + + + + + +
                                                                      TypeDescription
                                                                      System.UInt32
                                                                      + +

                                                                      MarginLeft

                                                                      +
                                                                      +Amount of space to leave on left of control. Graph content (Series) +will not be rendered in margins but axis labels may be +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public uint MarginLeft { get; set; }
                                                                      +
                                                                      +
                                                                      Property Value
                                                                      + + + + + + + + + + + + + +
                                                                      TypeDescription
                                                                      System.UInt32
                                                                      + +

                                                                      ScrollOffset

                                                                      +
                                                                      +The graph space position of the bottom left of the control. +Changing this scrolls the viewport around in the graph +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public PointF ScrollOffset { get; set; }
                                                                      +
                                                                      +
                                                                      Property Value
                                                                      + + + + + + + + + + + + + +
                                                                      TypeDescription
                                                                      PointF
                                                                      + +

                                                                      Series

                                                                      +
                                                                      +Collection of data series that are rendered in the graph +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public List<ISeries> Series { get; }
                                                                      +
                                                                      +
                                                                      Property Value
                                                                      + + + + + + + + + + + + + +
                                                                      TypeDescription
                                                                      System.Collections.Generic.List<ISeries>
                                                                      +

                                                                      Methods +

                                                                      + +

                                                                      DrawLine(Point, Point, Rune)

                                                                      +
                                                                      +Draws a line between two points in screen space. Can be diagonals. +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public void DrawLine(Point start, Point end, Rune symbol)
                                                                      +
                                                                      +
                                                                      Parameters
                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                      TypeNameDescription
                                                                      Pointstart
                                                                      Pointend
                                                                      System.RunesymbolThe symbol to use for the line
                                                                      + +

                                                                      GraphSpaceToScreen(PointF)

                                                                      +
                                                                      +Calculates the screen location for a given point in graph space. +Bear in mind these be off screen +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public Point GraphSpaceToScreen(PointF location)
                                                                      +
                                                                      +
                                                                      Parameters
                                                                      + + + + + + + + + + + + + + + +
                                                                      TypeNameDescription
                                                                      PointFlocationPoint in graph space that may or may not be represented in the +visible area of graph currently presented. E.g. 0,0 for origin
                                                                      +
                                                                      Returns
                                                                      + + + + + + + + + + + + + +
                                                                      TypeDescription
                                                                      PointScreen position (Column/Row) which would be used to render the graph location. +Note that this can be outside the current client area of the control
                                                                      + +

                                                                      PageDown()

                                                                      +
                                                                      +Scrolls the graph down 1 page +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public void PageDown()
                                                                      +
                                                                      + +

                                                                      PageUp()

                                                                      +
                                                                      +Scrolls the graph up 1 page +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public void PageUp()
                                                                      +
                                                                      + +

                                                                      ProcessKey(KeyEvent)

                                                                      +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public override bool ProcessKey(KeyEvent keyEvent)
                                                                      +
                                                                      +
                                                                      Parameters
                                                                      + + + + + + + + + + + + + + + +
                                                                      TypeNameDescription
                                                                      KeyEventkeyEvent
                                                                      +
                                                                      Returns
                                                                      + + + + + + + + + + + + + +
                                                                      TypeDescription
                                                                      System.Boolean
                                                                      +
                                                                      Overrides
                                                                      + + +

                                                                      Redraw(Rect)

                                                                      +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public override void Redraw(Rect bounds)
                                                                      +
                                                                      +
                                                                      Parameters
                                                                      + + + + + + + + + + + + + + + +
                                                                      TypeNameDescription
                                                                      Rectbounds
                                                                      +
                                                                      Overrides
                                                                      + + +

                                                                      Reset()

                                                                      +
                                                                      +Clears all settings configured on the graph and resets all properties +to default values (CellSize, ScrollOffset etc) +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public void Reset()
                                                                      +
                                                                      + +

                                                                      ScreenToGraphSpace(Int32, Int32)

                                                                      +
                                                                      +Returns the section of the graph that is represented by the given +screen position +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public RectangleF ScreenToGraphSpace(int col, int row)
                                                                      +
                                                                      +
                                                                      Parameters
                                                                      + + + + + + + + + + + + + + + + + + + + +
                                                                      TypeNameDescription
                                                                      System.Int32col
                                                                      System.Int32row
                                                                      +
                                                                      Returns
                                                                      + + + + + + + + + + + + + +
                                                                      TypeDescription
                                                                      RectangleF
                                                                      + +

                                                                      ScreenToGraphSpace(Rect)

                                                                      +
                                                                      +Returns the section of the graph that is represented by the screen area +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public RectangleF ScreenToGraphSpace(Rect screenArea)
                                                                      +
                                                                      +
                                                                      Parameters
                                                                      + + + + + + + + + + + + + + + +
                                                                      TypeNameDescription
                                                                      RectscreenArea
                                                                      +
                                                                      Returns
                                                                      + + + + + + + + + + + + + +
                                                                      TypeDescription
                                                                      RectangleF
                                                                      + +

                                                                      Scroll(Single, Single)

                                                                      +
                                                                      +Scrolls the view by a given number of units in graph space. +See CellSize to translate this into rows/cols +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public void Scroll(float offsetX, float offsetY)
                                                                      +
                                                                      +
                                                                      Parameters
                                                                      + + + + + + + + + + + + + + + + + + + + +
                                                                      TypeNameDescription
                                                                      System.SingleoffsetX
                                                                      System.SingleoffsetY
                                                                      + +

                                                                      SetDriverColorToGraphColor()

                                                                      +
                                                                      +Sets the color attribute of Driver to the GraphColor +(if defined) or ColorScheme otherwise. +
                                                                      +
                                                                      +
                                                                      Declaration
                                                                      +
                                                                      + 
                                                                      public void SetDriverColorToGraphColor()
                                                                      +
                                                                      +

                                                                      Implements

                                                                      +
                                                                      + System.IDisposable +
                                                                      +
                                                                      + System.ComponentModel.ISupportInitializeNotification +
                                                                      +
                                                                      + System.ComponentModel.ISupportInitialize +
                                                                      +
                                                                      +
                                                                      + + +
                                                                      +
                                                                      + + +
                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.Axis.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.Axis.html new file mode 100644 index 0000000000..92e9699f54 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.Axis.html @@ -0,0 +1,510 @@ + + + + + + + + Class Axis + + + + + + + + + + + + + + + + +
                                                                      +
                                                                      + + + +
                                                                      + +
                                                                      +
                                                                      +
                                                                      + +
                                                                      +
                                                                      Search Results for
                                                                      +
                                                                      +

                                                                      +
                                                                      +
                                                                        +
                                                                        +
                                                                        +
                                                                        + +
                                                                        + +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        + + +

                                                                        Class Axis +

                                                                        +
                                                                        +Renders a continuous line with grid line ticks and labels +
                                                                        +
                                                                        +
                                                                        +
                                                                        Inheritance
                                                                        +
                                                                        System.Object
                                                                        +
                                                                        Axis
                                                                        +
                                                                        HorizontalAxis
                                                                        +
                                                                        VerticalAxis
                                                                        +
                                                                        +
                                                                        +
                                                                        Inherited Members
                                                                        +
                                                                        + System.Object.Equals(System.Object) +
                                                                        +
                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                        +
                                                                        + System.Object.GetHashCode() +
                                                                        +
                                                                        + System.Object.GetType() +
                                                                        +
                                                                        + System.Object.MemberwiseClone() +
                                                                        +
                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                        +
                                                                        + System.Object.ToString() +
                                                                        +
                                                                        +
                                                                        Namespace: Terminal.Gui.Graphs
                                                                        +
                                                                        Assembly: Terminal.Gui.dll
                                                                        +
                                                                        Syntax
                                                                        +
                                                                        + 
                                                                        public abstract class Axis
                                                                        +
                                                                        +

                                                                        Constructors +

                                                                        + +

                                                                        Axis(Orientation)

                                                                        +
                                                                        +Populates base properties and sets the read only Orientation +
                                                                        +
                                                                        +
                                                                        Declaration
                                                                        +
                                                                        + 
                                                                        protected Axis(Orientation orientation)
                                                                        +
                                                                        +
                                                                        Parameters
                                                                        + + + + + + + + + + + + + + + +
                                                                        TypeNameDescription
                                                                        Orientationorientation
                                                                        +

                                                                        Fields +

                                                                        +

                                                                        LabelGetter

                                                                        +
                                                                        +Allows you to control what label text is rendered for a given Increment +when ShowLabelsEvery is above 0 +
                                                                        +
                                                                        +
                                                                        Declaration
                                                                        +
                                                                        + 
                                                                        public LabelGetterDelegate LabelGetter
                                                                        +
                                                                        +
                                                                        Field Value
                                                                        + + + + + + + + + + + + + +
                                                                        TypeDescription
                                                                        LabelGetterDelegate
                                                                        +

                                                                        Properties +

                                                                        + +

                                                                        Increment

                                                                        +
                                                                        +Number of units of graph space between ticks on axis. 0 for no ticks +
                                                                        +
                                                                        +
                                                                        Declaration
                                                                        +
                                                                        + 
                                                                        public float Increment { get; set; }
                                                                        +
                                                                        +
                                                                        Property Value
                                                                        + + + + + + + + + + + + + +
                                                                        TypeDescription
                                                                        System.Single
                                                                        + +

                                                                        Minimum

                                                                        +
                                                                        +The minimum axis point to show. Defaults to null (no minimum) +
                                                                        +
                                                                        +
                                                                        Declaration
                                                                        +
                                                                        + 
                                                                        public float? Minimum { get; set; }
                                                                        +
                                                                        +
                                                                        Property Value
                                                                        + + + + + + + + + + + + + +
                                                                        TypeDescription
                                                                        System.Nullable<System.Single>
                                                                        + +

                                                                        Orientation

                                                                        +
                                                                        +Direction of the axis +
                                                                        +
                                                                        +
                                                                        Declaration
                                                                        +
                                                                        + 
                                                                        public Orientation Orientation { get; }
                                                                        +
                                                                        +
                                                                        Property Value
                                                                        + + + + + + + + + + + + + +
                                                                        TypeDescription
                                                                        Orientation
                                                                        + +

                                                                        ShowLabelsEvery

                                                                        +
                                                                        +The number of Increment before an label is added. +0 = never show labels +
                                                                        +
                                                                        +
                                                                        Declaration
                                                                        +
                                                                        + 
                                                                        public uint ShowLabelsEvery { get; set; }
                                                                        +
                                                                        +
                                                                        Property Value
                                                                        + + + + + + + + + + + + + +
                                                                        TypeDescription
                                                                        System.UInt32
                                                                        + +

                                                                        Text

                                                                        +
                                                                        +Displayed below/to left of labels (see Orientation). +If text is not visible, check MarginBottom / MarginLeft +
                                                                        +
                                                                        +
                                                                        Declaration
                                                                        +
                                                                        + 
                                                                        public string Text { get; set; }
                                                                        +
                                                                        +
                                                                        Property Value
                                                                        + + + + + + + + + + + + + +
                                                                        TypeDescription
                                                                        System.String
                                                                        + +

                                                                        Visible

                                                                        +
                                                                        +True to render axis. Defaults to true +
                                                                        +
                                                                        +
                                                                        Declaration
                                                                        +
                                                                        + 
                                                                        public bool Visible { get; set; }
                                                                        +
                                                                        +
                                                                        Property Value
                                                                        + + + + + + + + + + + + + +
                                                                        TypeDescription
                                                                        System.Boolean
                                                                        +

                                                                        Methods +

                                                                        + +

                                                                        DrawAxisLabel(GraphView, Int32, String)

                                                                        +
                                                                        +Draws a custom label text at screenPosition units +along the axis (X or Y depending on Orientation) +
                                                                        +
                                                                        +
                                                                        Declaration
                                                                        +
                                                                        + 
                                                                        public abstract void DrawAxisLabel(GraphView graph, int screenPosition, string text)
                                                                        +
                                                                        +
                                                                        Parameters
                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                        TypeNameDescription
                                                                        GraphViewgraph
                                                                        System.Int32screenPosition
                                                                        System.Stringtext
                                                                        + +

                                                                        DrawAxisLabels(GraphView)

                                                                        +
                                                                        +Draws labels and axis Increment ticks +
                                                                        +
                                                                        +
                                                                        Declaration
                                                                        +
                                                                        + 
                                                                        public abstract void DrawAxisLabels(GraphView graph)
                                                                        +
                                                                        +
                                                                        Parameters
                                                                        + + + + + + + + + + + + + + + +
                                                                        TypeNameDescription
                                                                        GraphViewgraph
                                                                        + +

                                                                        DrawAxisLine(GraphView)

                                                                        +
                                                                        +Draws the solid line of the axis +
                                                                        +
                                                                        +
                                                                        Declaration
                                                                        +
                                                                        + 
                                                                        public abstract void DrawAxisLine(GraphView graph)
                                                                        +
                                                                        +
                                                                        Parameters
                                                                        + + + + + + + + + + + + + + + +
                                                                        TypeNameDescription
                                                                        GraphViewgraph
                                                                        + +

                                                                        DrawAxisLine(GraphView, Int32, Int32)

                                                                        +
                                                                        +Draws a single cell of the solid line of the axis +
                                                                        +
                                                                        +
                                                                        Declaration
                                                                        +
                                                                        + 
                                                                        protected abstract void DrawAxisLine(GraphView graph, int x, int y)
                                                                        +
                                                                        +
                                                                        Parameters
                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                        TypeNameDescription
                                                                        GraphViewgraph
                                                                        System.Int32x
                                                                        System.Int32y
                                                                        + +

                                                                        Reset()

                                                                        +
                                                                        +Resets all configurable properties of the axis to default values +
                                                                        +
                                                                        +
                                                                        Declaration
                                                                        +
                                                                        + 
                                                                        public virtual void Reset()
                                                                        +
                                                                        +
                                                                        +
                                                                        + + +
                                                                        +
                                                                        + + +
                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.AxisIncrementToRender.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.AxisIncrementToRender.html new file mode 100644 index 0000000000..20791ea15f --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.AxisIncrementToRender.html @@ -0,0 +1,276 @@ + + + + + + + + Class AxisIncrementToRender + + + + + + + + + + + + + + + + +
                                                                        +
                                                                        + + + +
                                                                        + +
                                                                        +
                                                                        +
                                                                        + +
                                                                        +
                                                                        Search Results for
                                                                        +
                                                                        +

                                                                        +
                                                                        +
                                                                          +
                                                                          +
                                                                          +
                                                                          + +
                                                                          + +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          + + +

                                                                          Class AxisIncrementToRender +

                                                                          +
                                                                          +A location on an axis of a GraphView that may +or may not have a label associated with it +
                                                                          +
                                                                          +
                                                                          +
                                                                          Inheritance
                                                                          +
                                                                          System.Object
                                                                          +
                                                                          AxisIncrementToRender
                                                                          +
                                                                          +
                                                                          +
                                                                          Inherited Members
                                                                          +
                                                                          + System.Object.Equals(System.Object) +
                                                                          +
                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                          +
                                                                          + System.Object.GetHashCode() +
                                                                          +
                                                                          + System.Object.GetType() +
                                                                          +
                                                                          + System.Object.MemberwiseClone() +
                                                                          +
                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                          +
                                                                          + System.Object.ToString() +
                                                                          +
                                                                          +
                                                                          Namespace: Terminal.Gui.Graphs
                                                                          +
                                                                          Assembly: Terminal.Gui.dll
                                                                          +
                                                                          Syntax
                                                                          +
                                                                          + 
                                                                          public class AxisIncrementToRender
                                                                          +
                                                                          +

                                                                          Constructors +

                                                                          + +

                                                                          AxisIncrementToRender(Orientation, Int32, Single)

                                                                          +
                                                                          +Describe a new section of an axis that requires an axis increment +symbol and/or label +
                                                                          +
                                                                          +
                                                                          Declaration
                                                                          +
                                                                          + 
                                                                          public AxisIncrementToRender(Orientation orientation, int screen, float value)
                                                                          +
                                                                          +
                                                                          Parameters
                                                                          + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                          TypeNameDescription
                                                                          Orientationorientation
                                                                          System.Int32screen
                                                                          System.Singlevalue
                                                                          +

                                                                          Properties +

                                                                          + +

                                                                          Orientation

                                                                          +
                                                                          +Direction of the parent axis +
                                                                          +
                                                                          +
                                                                          Declaration
                                                                          +
                                                                          + 
                                                                          public Orientation Orientation { get; }
                                                                          +
                                                                          +
                                                                          Property Value
                                                                          + + + + + + + + + + + + + +
                                                                          TypeDescription
                                                                          Orientation
                                                                          + +

                                                                          ScreenLocation

                                                                          +
                                                                          +The screen location (X or Y depending on Orientation) that the +increment will be rendered at +
                                                                          +
                                                                          +
                                                                          Declaration
                                                                          +
                                                                          + 
                                                                          public int ScreenLocation { get; }
                                                                          +
                                                                          +
                                                                          Property Value
                                                                          + + + + + + + + + + + + + +
                                                                          TypeDescription
                                                                          System.Int32
                                                                          + +

                                                                          Value

                                                                          +
                                                                          +The value at this position on the axis in graph space +
                                                                          +
                                                                          +
                                                                          Declaration
                                                                          +
                                                                          + 
                                                                          public float Value { get; }
                                                                          +
                                                                          +
                                                                          Property Value
                                                                          + + + + + + + + + + + + + +
                                                                          TypeDescription
                                                                          System.Single
                                                                          +
                                                                          +
                                                                          + + +
                                                                          +
                                                                          + + +
                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.Bar.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.Bar.html new file mode 100644 index 0000000000..3f8f439342 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.Bar.html @@ -0,0 +1,276 @@ + + + + + + + + Class BarSeries.Bar + + + + + + + + + + + + + + + + +
                                                                          +
                                                                          + + + +
                                                                          + +
                                                                          +
                                                                          +
                                                                          + +
                                                                          +
                                                                          Search Results for
                                                                          +
                                                                          +

                                                                          +
                                                                          +
                                                                            +
                                                                            +
                                                                            +
                                                                            + +
                                                                            + +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            + + +

                                                                            Class BarSeries.Bar +

                                                                            +
                                                                            +A single bar in a BarSeries +
                                                                            +
                                                                            +
                                                                            +
                                                                            Inheritance
                                                                            +
                                                                            System.Object
                                                                            +
                                                                            BarSeries.Bar
                                                                            +
                                                                            +
                                                                            +
                                                                            Inherited Members
                                                                            +
                                                                            + System.Object.Equals(System.Object) +
                                                                            +
                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                            +
                                                                            + System.Object.GetHashCode() +
                                                                            +
                                                                            + System.Object.GetType() +
                                                                            +
                                                                            + System.Object.MemberwiseClone() +
                                                                            +
                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                            +
                                                                            + System.Object.ToString() +
                                                                            +
                                                                            +
                                                                            Namespace: Terminal.Gui.Graphs
                                                                            +
                                                                            Assembly: Terminal.Gui.dll
                                                                            +
                                                                            Syntax
                                                                            +
                                                                            + 
                                                                            public class Bar
                                                                            +
                                                                            +

                                                                            Constructors +

                                                                            + +

                                                                            Bar(String, GraphCellToRender, Single)

                                                                            +
                                                                            +Creates a new instance of a single bar rendered in the given fill that extends +out value graph space units in the default Orientation +
                                                                            +
                                                                            +
                                                                            Declaration
                                                                            +
                                                                            + 
                                                                            public Bar(string text, GraphCellToRender fill, float value)
                                                                            +
                                                                            +
                                                                            Parameters
                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                            TypeNameDescription
                                                                            System.Stringtext
                                                                            GraphCellToRenderfill
                                                                            System.Singlevalue
                                                                            +

                                                                            Properties +

                                                                            + +

                                                                            Fill

                                                                            +
                                                                            +The color and character that will be rendered in the console +when the bar extends over it +
                                                                            +
                                                                            +
                                                                            Declaration
                                                                            +
                                                                            + 
                                                                            public GraphCellToRender Fill { get; set; }
                                                                            +
                                                                            +
                                                                            Property Value
                                                                            + + + + + + + + + + + + + +
                                                                            TypeDescription
                                                                            GraphCellToRender
                                                                            + +

                                                                            Text

                                                                            +
                                                                            +Optional text that describes the bar. This will be rendered on the corresponding +Axis unless DrawLabels is false +
                                                                            +
                                                                            +
                                                                            Declaration
                                                                            +
                                                                            + 
                                                                            public string Text { get; set; }
                                                                            +
                                                                            +
                                                                            Property Value
                                                                            + + + + + + + + + + + + + +
                                                                            TypeDescription
                                                                            System.String
                                                                            + +

                                                                            Value

                                                                            +
                                                                            +The value in graph space X/Y (depending on Orientation) to which the bar extends. +
                                                                            +
                                                                            +
                                                                            Declaration
                                                                            +
                                                                            + 
                                                                            public float Value { get; }
                                                                            +
                                                                            +
                                                                            Property Value
                                                                            + + + + + + + + + + + + + +
                                                                            TypeDescription
                                                                            System.Single
                                                                            +
                                                                            +
                                                                            + + +
                                                                            +
                                                                            + + +
                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.html new file mode 100644 index 0000000000..3fdcf1717b --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.html @@ -0,0 +1,446 @@ + + + + + + + + Class BarSeries + + + + + + + + + + + + + + + + +
                                                                            +
                                                                            + + + +
                                                                            + +
                                                                            +
                                                                            +
                                                                            + +
                                                                            +
                                                                            Search Results for
                                                                            +
                                                                            +

                                                                            +
                                                                            +
                                                                              +
                                                                              +
                                                                              +
                                                                              + +
                                                                              + +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              + + +

                                                                              Class BarSeries +

                                                                              +
                                                                              +Series of bars positioned at regular intervals +
                                                                              +
                                                                              +
                                                                              +
                                                                              Inheritance
                                                                              +
                                                                              System.Object
                                                                              +
                                                                              BarSeries
                                                                              +
                                                                              +
                                                                              +
                                                                              Implements
                                                                              + +
                                                                              +
                                                                              +
                                                                              Inherited Members
                                                                              +
                                                                              + System.Object.Equals(System.Object) +
                                                                              +
                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                              +
                                                                              + System.Object.GetHashCode() +
                                                                              +
                                                                              + System.Object.GetType() +
                                                                              +
                                                                              + System.Object.MemberwiseClone() +
                                                                              +
                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                              +
                                                                              + System.Object.ToString() +
                                                                              +
                                                                              +
                                                                              Namespace: Terminal.Gui.Graphs
                                                                              +
                                                                              Assembly: Terminal.Gui.dll
                                                                              +
                                                                              Syntax
                                                                              +
                                                                              + 
                                                                              public class BarSeries : ISeries
                                                                              +
                                                                              +

                                                                              Properties +

                                                                              + +

                                                                              BarEvery

                                                                              +
                                                                              +Determines the spacing of bars along the axis. Defaults to 1 i.e. +every 1 unit of graph space a bar is rendered. Note that you should +also consider CellSize when changing this. +
                                                                              +
                                                                              +
                                                                              Declaration
                                                                              +
                                                                              + 
                                                                              public float BarEvery { get; set; }
                                                                              +
                                                                              +
                                                                              Property Value
                                                                              + + + + + + + + + + + + + +
                                                                              TypeDescription
                                                                              System.Single
                                                                              + +

                                                                              Bars

                                                                              +
                                                                              +Ordered collection of graph bars to position along axis +
                                                                              +
                                                                              +
                                                                              Declaration
                                                                              +
                                                                              + 
                                                                              public List<BarSeries.Bar> Bars { get; set; }
                                                                              +
                                                                              +
                                                                              Property Value
                                                                              + + + + + + + + + + + + + +
                                                                              TypeDescription
                                                                              System.Collections.Generic.List<BarSeries.Bar>
                                                                              + +

                                                                              DrawLabels

                                                                              +
                                                                              +True to draw Text along the axis under the bar. Defaults +to true. +
                                                                              +
                                                                              +
                                                                              Declaration
                                                                              +
                                                                              + 
                                                                              public bool DrawLabels { get; set; }
                                                                              +
                                                                              +
                                                                              Property Value
                                                                              + + + + + + + + + + + + + +
                                                                              TypeDescription
                                                                              System.Boolean
                                                                              + +

                                                                              Offset

                                                                              +
                                                                              +The number of units of graph space along the axis before rendering the first bar +(and subsequent bars - see BarEvery). Defaults to 0 +
                                                                              +
                                                                              +
                                                                              Declaration
                                                                              +
                                                                              + 
                                                                              public float Offset { get; set; }
                                                                              +
                                                                              +
                                                                              Property Value
                                                                              + + + + + + + + + + + + + +
                                                                              TypeDescription
                                                                              System.Single
                                                                              + +

                                                                              Orientation

                                                                              +
                                                                              +Direction bars protrude from the corresponding axis. +Defaults to vertical +
                                                                              +
                                                                              +
                                                                              Declaration
                                                                              +
                                                                              + 
                                                                              public Orientation Orientation { get; set; }
                                                                              +
                                                                              +
                                                                              Property Value
                                                                              + + + + + + + + + + + + + +
                                                                              TypeDescription
                                                                              Orientation
                                                                              + +

                                                                              OverrideBarColor

                                                                              +
                                                                              +Overrides the Fill with a fixed color +
                                                                              +
                                                                              +
                                                                              Declaration
                                                                              +
                                                                              + 
                                                                              public Attribute? OverrideBarColor { get; set; }
                                                                              +
                                                                              +
                                                                              Property Value
                                                                              + + + + + + + + + + + + + +
                                                                              TypeDescription
                                                                              System.Nullable<Attribute>
                                                                              +

                                                                              Methods +

                                                                              + +

                                                                              AdjustColor(GraphCellToRender)

                                                                              +
                                                                              +Applies any color overriding +
                                                                              +
                                                                              +
                                                                              Declaration
                                                                              +
                                                                              + 
                                                                              protected virtual GraphCellToRender AdjustColor(GraphCellToRender graphCellToRender)
                                                                              +
                                                                              +
                                                                              Parameters
                                                                              + + + + + + + + + + + + + + + +
                                                                              TypeNameDescription
                                                                              GraphCellToRendergraphCellToRender
                                                                              +
                                                                              Returns
                                                                              + + + + + + + + + + + + + +
                                                                              TypeDescription
                                                                              GraphCellToRender
                                                                              + +

                                                                              DrawBarLine(GraphView, Point, Point, BarSeries.Bar)

                                                                              +
                                                                              +Override to do custom drawing of the bar e.g. to apply varying color or changing the fill +symbol mid bar. +
                                                                              +
                                                                              +
                                                                              Declaration
                                                                              +
                                                                              + 
                                                                              protected virtual void DrawBarLine(GraphView graph, Point start, Point end, BarSeries.Bar beingDrawn)
                                                                              +
                                                                              +
                                                                              Parameters
                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                              TypeNameDescription
                                                                              GraphViewgraph
                                                                              PointstartScreen position of the start of the bar
                                                                              PointendScreen position of the end of the bar
                                                                              BarSeries.BarbeingDrawnThe Bar that occupies this space and is being drawn
                                                                              + +

                                                                              DrawSeries(GraphView, Rect, RectangleF)

                                                                              +
                                                                              +Draws bars that are currently in the drawBounds +
                                                                              +
                                                                              +
                                                                              Declaration
                                                                              +
                                                                              + 
                                                                              public virtual void DrawSeries(GraphView graph, Rect drawBounds, RectangleF graphBounds)
                                                                              +
                                                                              +
                                                                              Parameters
                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                              TypeNameDescription
                                                                              GraphViewgraph
                                                                              RectdrawBoundsScreen area of the graph excluding margins
                                                                              RectangleFgraphBoundsGraph space area that should be drawn into drawBounds
                                                                              +

                                                                              Implements

                                                                              +
                                                                              + ISeries +
                                                                              +
                                                                              +
                                                                              + + +
                                                                              +
                                                                              + + +
                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.GraphCellToRender.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.GraphCellToRender.html new file mode 100644 index 0000000000..848e34ba61 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.GraphCellToRender.html @@ -0,0 +1,303 @@ + + + + + + + + Class GraphCellToRender + + + + + + + + + + + + + + + + +
                                                                              +
                                                                              + + + +
                                                                              + +
                                                                              +
                                                                              +
                                                                              + +
                                                                              +
                                                                              Search Results for
                                                                              +
                                                                              +

                                                                              +
                                                                              +
                                                                                +
                                                                                +
                                                                                +
                                                                                + +
                                                                                + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                + + +

                                                                                Class GraphCellToRender +

                                                                                +
                                                                                +Describes how to render a single row/column of a GraphView based +on the value(s) in ISeries at that location +
                                                                                +
                                                                                +
                                                                                +
                                                                                Inheritance
                                                                                +
                                                                                System.Object
                                                                                +
                                                                                GraphCellToRender
                                                                                +
                                                                                +
                                                                                +
                                                                                Inherited Members
                                                                                +
                                                                                + System.Object.Equals(System.Object) +
                                                                                +
                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                +
                                                                                + System.Object.GetHashCode() +
                                                                                +
                                                                                + System.Object.GetType() +
                                                                                +
                                                                                + System.Object.MemberwiseClone() +
                                                                                +
                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                +
                                                                                + System.Object.ToString() +
                                                                                +
                                                                                +
                                                                                Namespace: Terminal.Gui.Graphs
                                                                                +
                                                                                Assembly: Terminal.Gui.dll
                                                                                +
                                                                                Syntax
                                                                                +
                                                                                + 
                                                                                public class GraphCellToRender
                                                                                +
                                                                                +

                                                                                Constructors +

                                                                                + +

                                                                                GraphCellToRender(Rune)

                                                                                +
                                                                                +Creates instance and sets Rune with default graph coloring +
                                                                                +
                                                                                +
                                                                                Declaration
                                                                                +
                                                                                + 
                                                                                public GraphCellToRender(Rune rune)
                                                                                +
                                                                                +
                                                                                Parameters
                                                                                + + + + + + + + + + + + + + + +
                                                                                TypeNameDescription
                                                                                System.Runerune
                                                                                + +

                                                                                GraphCellToRender(Rune, Nullable<Attribute>)

                                                                                +
                                                                                +Creates instance and sets Rune and Color (or default if null) +
                                                                                +
                                                                                +
                                                                                Declaration
                                                                                +
                                                                                + 
                                                                                public GraphCellToRender(Rune rune, Attribute? color)
                                                                                +
                                                                                +
                                                                                Parameters
                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                TypeNameDescription
                                                                                System.Runerune
                                                                                System.Nullable<Attribute>color
                                                                                + +

                                                                                GraphCellToRender(Rune, Attribute)

                                                                                +
                                                                                +Creates instance and sets Rune with custom graph coloring +
                                                                                +
                                                                                +
                                                                                Declaration
                                                                                +
                                                                                + 
                                                                                public GraphCellToRender(Rune rune, Attribute color)
                                                                                +
                                                                                +
                                                                                Parameters
                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                TypeNameDescription
                                                                                System.Runerune
                                                                                Attributecolor
                                                                                +

                                                                                Properties +

                                                                                + +

                                                                                Color

                                                                                +
                                                                                +Optional color to render the Rune with +
                                                                                +
                                                                                +
                                                                                Declaration
                                                                                +
                                                                                + 
                                                                                public Attribute? Color { get; set; }
                                                                                +
                                                                                +
                                                                                Property Value
                                                                                + + + + + + + + + + + + + +
                                                                                TypeDescription
                                                                                System.Nullable<Attribute>
                                                                                + +

                                                                                Rune

                                                                                +
                                                                                +The character to render in the console +
                                                                                +
                                                                                +
                                                                                Declaration
                                                                                +
                                                                                + 
                                                                                public Rune Rune { get; set; }
                                                                                +
                                                                                +
                                                                                Property Value
                                                                                + + + + + + + + + + + + + +
                                                                                TypeDescription
                                                                                System.Rune
                                                                                +
                                                                                +
                                                                                + + +
                                                                                +
                                                                                + + +
                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.HorizontalAxis.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.HorizontalAxis.html new file mode 100644 index 0000000000..34fd7cd86d --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.HorizontalAxis.html @@ -0,0 +1,378 @@ + + + + + + + + Class HorizontalAxis + + + + + + + + + + + + + + + + +
                                                                                +
                                                                                + + + +
                                                                                + +
                                                                                +
                                                                                +
                                                                                + +
                                                                                +
                                                                                Search Results for
                                                                                +
                                                                                +

                                                                                +
                                                                                +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  + +
                                                                                  + +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  + + +

                                                                                  Class HorizontalAxis +

                                                                                  +
                                                                                  +The horizontal (x axis) of a GraphView +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  Inheritance
                                                                                  +
                                                                                  System.Object
                                                                                  +
                                                                                  Axis
                                                                                  +
                                                                                  HorizontalAxis
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  Inherited Members
                                                                                  + + + + + +
                                                                                  + Axis.Text +
                                                                                  + + +
                                                                                  + System.Object.Equals(System.Object) +
                                                                                  +
                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                  +
                                                                                  + System.Object.GetHashCode() +
                                                                                  +
                                                                                  + System.Object.GetType() +
                                                                                  +
                                                                                  + System.Object.MemberwiseClone() +
                                                                                  +
                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                  +
                                                                                  + System.Object.ToString() +
                                                                                  +
                                                                                  +
                                                                                  Namespace: Terminal.Gui.Graphs
                                                                                  +
                                                                                  Assembly: Terminal.Gui.dll
                                                                                  +
                                                                                  Syntax
                                                                                  +
                                                                                  + 
                                                                                  public class HorizontalAxis : Axis
                                                                                  +
                                                                                  +

                                                                                  Constructors +

                                                                                  + +

                                                                                  HorizontalAxis()

                                                                                  +
                                                                                  +Creates a new instance of axis with an Orientation of Horizontal +
                                                                                  +
                                                                                  +
                                                                                  Declaration
                                                                                  +
                                                                                  + 
                                                                                  public HorizontalAxis()
                                                                                  +
                                                                                  +

                                                                                  Methods +

                                                                                  + +

                                                                                  DrawAxisLabel(GraphView, Int32, String)

                                                                                  +
                                                                                  +Draws the given text on the axis at x screenPosition. +For the screen y position use GetAxisYPosition(GraphView) +
                                                                                  +
                                                                                  +
                                                                                  Declaration
                                                                                  +
                                                                                  + 
                                                                                  public override void DrawAxisLabel(GraphView graph, int screenPosition, string text)
                                                                                  +
                                                                                  +
                                                                                  Parameters
                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                  TypeNameDescription
                                                                                  GraphViewgraphGraph being drawn onto
                                                                                  System.Int32screenPositionNumber of screen columns along the axis to take before rendering
                                                                                  System.StringtextText to render under the axis tick
                                                                                  +
                                                                                  Overrides
                                                                                  + + +

                                                                                  DrawAxisLabels(GraphView)

                                                                                  +
                                                                                  +Draws the horizontal x axis labels and Increment ticks +
                                                                                  +
                                                                                  +
                                                                                  Declaration
                                                                                  +
                                                                                  + 
                                                                                  public override void DrawAxisLabels(GraphView graph)
                                                                                  +
                                                                                  +
                                                                                  Parameters
                                                                                  + + + + + + + + + + + + + + + +
                                                                                  TypeNameDescription
                                                                                  GraphViewgraph
                                                                                  +
                                                                                  Overrides
                                                                                  + + +

                                                                                  DrawAxisLine(GraphView)

                                                                                  +
                                                                                  +Draws the horizontal axis line +
                                                                                  +
                                                                                  +
                                                                                  Declaration
                                                                                  +
                                                                                  + 
                                                                                  public override void DrawAxisLine(GraphView graph)
                                                                                  +
                                                                                  +
                                                                                  Parameters
                                                                                  + + + + + + + + + + + + + + + +
                                                                                  TypeNameDescription
                                                                                  GraphViewgraph
                                                                                  +
                                                                                  Overrides
                                                                                  + + +

                                                                                  DrawAxisLine(GraphView, Int32, Int32)

                                                                                  +
                                                                                  +Draws a horizontal axis line at the given x, y +screen coordinates +
                                                                                  +
                                                                                  +
                                                                                  Declaration
                                                                                  +
                                                                                  + 
                                                                                  protected override void DrawAxisLine(GraphView graph, int x, int y)
                                                                                  +
                                                                                  +
                                                                                  Parameters
                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                  TypeNameDescription
                                                                                  GraphViewgraph
                                                                                  System.Int32x
                                                                                  System.Int32y
                                                                                  +
                                                                                  Overrides
                                                                                  + + +

                                                                                  GetAxisYPosition(GraphView)

                                                                                  +
                                                                                  +Returns the Y screen position of the origin (typically 0,0) of graph space. +Return value is bounded by the screen i.e. the axis is always rendered even +if the origin is offscreen. +
                                                                                  +
                                                                                  +
                                                                                  Declaration
                                                                                  +
                                                                                  + 
                                                                                  public int GetAxisYPosition(GraphView graph)
                                                                                  +
                                                                                  +
                                                                                  Parameters
                                                                                  + + + + + + + + + + + + + + + +
                                                                                  TypeNameDescription
                                                                                  GraphViewgraph
                                                                                  +
                                                                                  Returns
                                                                                  + + + + + + + + + + + + + +
                                                                                  TypeDescription
                                                                                  System.Int32
                                                                                  +
                                                                                  +
                                                                                  + + +
                                                                                  +
                                                                                  + + +
                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.IAnnotation.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.IAnnotation.html new file mode 100644 index 0000000000..3f8c48997c --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.IAnnotation.html @@ -0,0 +1,196 @@ + + + + + + + + Interface IAnnotation + + + + + + + + + + + + + + + + +
                                                                                  +
                                                                                  + + + +
                                                                                  + +
                                                                                  +
                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  Search Results for
                                                                                  +
                                                                                  +

                                                                                  +
                                                                                  +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    + +
                                                                                    + +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    + + +

                                                                                    Interface IAnnotation +

                                                                                    +
                                                                                    +

                                                                                    Describes an overlay element that is rendered either before or +after a series.

                                                                                    + +

                                                                                    Annotations can be positioned either in screen space (e.g. +a legend) or in graph space (e.g. a line showing high point) +

                                                                                    +

                                                                                    Unlike ISeries, annotations are allowed to +draw into graph margins +

                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    Namespace: Terminal.Gui.Graphs
                                                                                    +
                                                                                    Assembly: Terminal.Gui.dll
                                                                                    +
                                                                                    Syntax
                                                                                    +
                                                                                    + 
                                                                                    public interface IAnnotation
                                                                                    +
                                                                                    +

                                                                                    Properties +

                                                                                    + +

                                                                                    BeforeSeries

                                                                                    +
                                                                                    +True if annotation should be drawn before ISeries. This +allowes Series and later annotations to potentially draw over the top +of this annotation. +
                                                                                    +
                                                                                    +
                                                                                    Declaration
                                                                                    +
                                                                                    + 
                                                                                    bool BeforeSeries { get; }
                                                                                    +
                                                                                    +
                                                                                    Property Value
                                                                                    + + + + + + + + + + + + + +
                                                                                    TypeDescription
                                                                                    System.Boolean
                                                                                    +

                                                                                    Methods +

                                                                                    + +

                                                                                    Render(GraphView)

                                                                                    +
                                                                                    +Called once after series have been rendered (or before if BeforeSeries is true). +Use Driver to draw and Bounds to avoid drawing outside of +graph +
                                                                                    +
                                                                                    +
                                                                                    Declaration
                                                                                    +
                                                                                    + 
                                                                                    void Render(GraphView graph)
                                                                                    +
                                                                                    +
                                                                                    Parameters
                                                                                    + + + + + + + + + + + + + + + +
                                                                                    TypeNameDescription
                                                                                    GraphViewgraph
                                                                                    +
                                                                                    +
                                                                                    + + +
                                                                                    +
                                                                                    + + +
                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.ISeries.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.ISeries.html new file mode 100644 index 0000000000..a67565c437 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.ISeries.html @@ -0,0 +1,168 @@ + + + + + + + + Interface ISeries + + + + + + + + + + + + + + + + +
                                                                                    +
                                                                                    + + + +
                                                                                    + +
                                                                                    +
                                                                                    +
                                                                                    + +
                                                                                    +
                                                                                    Search Results for
                                                                                    +
                                                                                    +

                                                                                    +
                                                                                    +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + + +

                                                                                      Interface ISeries +

                                                                                      +
                                                                                      +Describes a series of data that can be rendered into a GraphView> +
                                                                                      +
                                                                                      +
                                                                                      Namespace: Terminal.Gui.Graphs
                                                                                      +
                                                                                      Assembly: Terminal.Gui.dll
                                                                                      +
                                                                                      Syntax
                                                                                      +
                                                                                      + 
                                                                                      public interface ISeries
                                                                                      +
                                                                                      +

                                                                                      Methods +

                                                                                      + +

                                                                                      DrawSeries(GraphView, Rect, RectangleF)

                                                                                      +
                                                                                      +Draws the graphBounds section of a series into the +graph view drawBounds +
                                                                                      +
                                                                                      +
                                                                                      Declaration
                                                                                      +
                                                                                      + 
                                                                                      void DrawSeries(GraphView graph, Rect drawBounds, RectangleF graphBounds)
                                                                                      +
                                                                                      +
                                                                                      Parameters
                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                      TypeNameDescription
                                                                                      GraphViewgraphGraph series is to be drawn onto
                                                                                      RectdrawBoundsVisible area of the graph in Console Screen units (excluding margins)
                                                                                      RectangleFgraphBoundsVisible area of the graph in Graph space units
                                                                                      +
                                                                                      +
                                                                                      + + +
                                                                                      +
                                                                                      + + +
                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.LabelGetterDelegate.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.LabelGetterDelegate.html new file mode 100644 index 0000000000..495d7e8933 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.LabelGetterDelegate.html @@ -0,0 +1,160 @@ + + + + + + + + Delegate LabelGetterDelegate + + + + + + + + + + + + + + + + +
                                                                                      +
                                                                                      + + + +
                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      Search Results for
                                                                                      +
                                                                                      +

                                                                                      +
                                                                                      +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        + +
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        + + +

                                                                                        Delegate LabelGetterDelegate +

                                                                                        +
                                                                                        +Delegate for custom formatting of axis labels. Determines what should be displayed at a given label +
                                                                                        +
                                                                                        +
                                                                                        Namespace: Terminal.Gui.Graphs
                                                                                        +
                                                                                        Assembly: Terminal.Gui.dll
                                                                                        +
                                                                                        Syntax
                                                                                        +
                                                                                        + 
                                                                                        public delegate string LabelGetterDelegate(AxisIncrementToRender toRender);
                                                                                        +
                                                                                        +
                                                                                        Parameters
                                                                                        + + + + + + + + + + + + + + + +
                                                                                        TypeNameDescription
                                                                                        AxisIncrementToRendertoRenderThe axis increment to which the label is attached
                                                                                        +
                                                                                        Returns
                                                                                        + + + + + + + + + + + + + +
                                                                                        TypeDescription
                                                                                        System.String
                                                                                        +
                                                                                        +
                                                                                        + + +
                                                                                        +
                                                                                        + + +
                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.LegendAnnotation.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.LegendAnnotation.html new file mode 100644 index 0000000000..6c0fe81b87 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.LegendAnnotation.html @@ -0,0 +1,338 @@ + + + + + + + + Class LegendAnnotation + + + + + + + + + + + + + + + + +
                                                                                        +
                                                                                        + + + +
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        + +
                                                                                        +
                                                                                        Search Results for
                                                                                        +
                                                                                        +

                                                                                        +
                                                                                        +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          + +
                                                                                          + +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          + + +

                                                                                          Class LegendAnnotation +

                                                                                          +
                                                                                          +A box containing symbol definitions e.g. meanings for colors in a graph. +The 'Key' to the graph +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          Inheritance
                                                                                          +
                                                                                          System.Object
                                                                                          +
                                                                                          LegendAnnotation
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          Implements
                                                                                          + +
                                                                                          +
                                                                                          +
                                                                                          Inherited Members
                                                                                          +
                                                                                          + System.Object.Equals(System.Object) +
                                                                                          +
                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                          +
                                                                                          + System.Object.GetHashCode() +
                                                                                          +
                                                                                          + System.Object.GetType() +
                                                                                          +
                                                                                          + System.Object.MemberwiseClone() +
                                                                                          +
                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                          +
                                                                                          + System.Object.ToString() +
                                                                                          +
                                                                                          +
                                                                                          Namespace: Terminal.Gui.Graphs
                                                                                          +
                                                                                          Assembly: Terminal.Gui.dll
                                                                                          +
                                                                                          Syntax
                                                                                          +
                                                                                          + 
                                                                                          public class LegendAnnotation : IAnnotation
                                                                                          +
                                                                                          +

                                                                                          Constructors +

                                                                                          + +

                                                                                          LegendAnnotation(Rect)

                                                                                          +
                                                                                          +Creates a new empty legend at the given screen coordinates +
                                                                                          +
                                                                                          +
                                                                                          Declaration
                                                                                          +
                                                                                          + 
                                                                                          public LegendAnnotation(Rect legendBounds)
                                                                                          +
                                                                                          +
                                                                                          Parameters
                                                                                          + + + + + + + + + + + + + + + +
                                                                                          TypeNameDescription
                                                                                          RectlegendBoundsDefines the area available for the legend to render in +(within the graph). This is in screen units (i.e. not graph space)
                                                                                          +

                                                                                          Properties +

                                                                                          + +

                                                                                          BeforeSeries

                                                                                          +
                                                                                          +Returns false i.e. Lengends render after series +
                                                                                          +
                                                                                          +
                                                                                          Declaration
                                                                                          +
                                                                                          + 
                                                                                          public bool BeforeSeries { get; }
                                                                                          +
                                                                                          +
                                                                                          Property Value
                                                                                          + + + + + + + + + + + + + +
                                                                                          TypeDescription
                                                                                          System.Boolean
                                                                                          + +

                                                                                          Border

                                                                                          +
                                                                                          +True to draw a solid border around the legend. +Defaults to true. This border will be within the +Bounds and so reduces the width/height +available for text by 2 +
                                                                                          +
                                                                                          +
                                                                                          Declaration
                                                                                          +
                                                                                          + 
                                                                                          public bool Border { get; set; }
                                                                                          +
                                                                                          +
                                                                                          Property Value
                                                                                          + + + + + + + + + + + + + +
                                                                                          TypeDescription
                                                                                          System.Boolean
                                                                                          + +

                                                                                          Bounds

                                                                                          +
                                                                                          +Defines the screen area available for the legend to render in +
                                                                                          +
                                                                                          +
                                                                                          Declaration
                                                                                          +
                                                                                          + 
                                                                                          public Rect Bounds { get; set; }
                                                                                          +
                                                                                          +
                                                                                          Property Value
                                                                                          + + + + + + + + + + + + + +
                                                                                          TypeDescription
                                                                                          Rect
                                                                                          +

                                                                                          Methods +

                                                                                          + +

                                                                                          AddEntry(GraphCellToRender, String)

                                                                                          +
                                                                                          +Adds an entry into the legend. Duplicate entries are permissable +
                                                                                          +
                                                                                          +
                                                                                          Declaration
                                                                                          +
                                                                                          + 
                                                                                          public void AddEntry(GraphCellToRender graphCellToRender, string text)
                                                                                          +
                                                                                          +
                                                                                          Parameters
                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                          TypeNameDescription
                                                                                          GraphCellToRendergraphCellToRenderThe symbol appearing on the graph that should appear in the legend
                                                                                          System.StringtextText to render on this line of the legend. Will be truncated +if outside of Legend Bounds
                                                                                          + +

                                                                                          Render(GraphView)

                                                                                          +
                                                                                          +Draws the Legend and all entries into the area within Bounds +
                                                                                          +
                                                                                          +
                                                                                          Declaration
                                                                                          +
                                                                                          + 
                                                                                          public void Render(GraphView graph)
                                                                                          +
                                                                                          +
                                                                                          Parameters
                                                                                          + + + + + + + + + + + + + + + +
                                                                                          TypeNameDescription
                                                                                          GraphViewgraph
                                                                                          +

                                                                                          Implements

                                                                                          + +
                                                                                          +
                                                                                          + + +
                                                                                          +
                                                                                          + + +
                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.MultiBarSeries.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.MultiBarSeries.html new file mode 100644 index 0000000000..a2d34212e2 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.MultiBarSeries.html @@ -0,0 +1,340 @@ + + + + + + + + Class MultiBarSeries + + + + + + + + + + + + + + + + +
                                                                                          +
                                                                                          + + + +
                                                                                          + +
                                                                                          +
                                                                                          +
                                                                                          + +
                                                                                          +
                                                                                          Search Results for
                                                                                          +
                                                                                          +

                                                                                          +
                                                                                          +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            + +
                                                                                            + +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            + + +

                                                                                            Class MultiBarSeries +

                                                                                            +
                                                                                            +Collection of BarSeries in which bars are clustered by category +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            Inheritance
                                                                                            +
                                                                                            System.Object
                                                                                            +
                                                                                            MultiBarSeries
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            Implements
                                                                                            + +
                                                                                            +
                                                                                            +
                                                                                            Inherited Members
                                                                                            +
                                                                                            + System.Object.Equals(System.Object) +
                                                                                            +
                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                            +
                                                                                            + System.Object.GetHashCode() +
                                                                                            +
                                                                                            + System.Object.GetType() +
                                                                                            +
                                                                                            + System.Object.MemberwiseClone() +
                                                                                            +
                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                            +
                                                                                            + System.Object.ToString() +
                                                                                            +
                                                                                            +
                                                                                            Namespace: Terminal.Gui.Graphs
                                                                                            +
                                                                                            Assembly: Terminal.Gui.dll
                                                                                            +
                                                                                            Syntax
                                                                                            +
                                                                                            + 
                                                                                            public class MultiBarSeries : ISeries
                                                                                            +
                                                                                            +

                                                                                            Constructors +

                                                                                            + +

                                                                                            MultiBarSeries(Int32, Single, Single, Attribute[])

                                                                                            +
                                                                                            +Creates a new series of clustered bars. +
                                                                                            +
                                                                                            +
                                                                                            Declaration
                                                                                            +
                                                                                            + 
                                                                                            public MultiBarSeries(int numberOfBarsPerCategory, float barsEvery, float spacing, Attribute[] colors = null)
                                                                                            +
                                                                                            +
                                                                                            Parameters
                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                            TypeNameDescription
                                                                                            System.Int32numberOfBarsPerCategoryEach category has this many bars
                                                                                            System.SinglebarsEveryHow far appart to put each category (in graph space)
                                                                                            System.SinglespacingHow much spacing between bars in a category (should be less than barsEvery/numberOfBarsPerCategory)
                                                                                            Attribute[]colorsArray of colors that define bar color in each category. Length must match numberOfBarsPerCategory
                                                                                            +

                                                                                            Properties +

                                                                                            + +

                                                                                            Spacing

                                                                                            +
                                                                                            +The number of units of graph space between bars. Should be +less than BarEvery +
                                                                                            +
                                                                                            +
                                                                                            Declaration
                                                                                            +
                                                                                            + 
                                                                                            public float Spacing { get; }
                                                                                            +
                                                                                            +
                                                                                            Property Value
                                                                                            + + + + + + + + + + + + + +
                                                                                            TypeDescription
                                                                                            System.Single
                                                                                            + +

                                                                                            SubSeries

                                                                                            +
                                                                                            +Sub collections. Each series contains the bars for a different category. Thus +SubSeries[0].Bars[0] is the first bar on the axis and SubSeries[1].Bars[0] is the +second etc +
                                                                                            +
                                                                                            +
                                                                                            Declaration
                                                                                            +
                                                                                            + 
                                                                                            public IReadOnlyCollection<BarSeries> SubSeries { get; }
                                                                                            +
                                                                                            +
                                                                                            Property Value
                                                                                            + + + + + + + + + + + + + +
                                                                                            TypeDescription
                                                                                            System.Collections.Generic.IReadOnlyCollection<BarSeries>
                                                                                            +

                                                                                            Methods +

                                                                                            + +

                                                                                            AddBars(String, Rune, Single[])

                                                                                            +
                                                                                            +Adds a new cluster of bars +
                                                                                            +
                                                                                            +
                                                                                            Declaration
                                                                                            +
                                                                                            + 
                                                                                            public void AddBars(string label, Rune fill, params float[] values)
                                                                                            +
                                                                                            +
                                                                                            Parameters
                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                            TypeNameDescription
                                                                                            System.Stringlabel
                                                                                            System.Runefill
                                                                                            System.Single[]valuesValues for each bar in category, must match the number of bars per category
                                                                                            + +

                                                                                            DrawSeries(GraphView, Rect, RectangleF)

                                                                                            +
                                                                                            +Draws all SubSeries +
                                                                                            +
                                                                                            +
                                                                                            Declaration
                                                                                            +
                                                                                            + 
                                                                                            public void DrawSeries(GraphView graph, Rect drawBounds, RectangleF graphBounds)
                                                                                            +
                                                                                            +
                                                                                            Parameters
                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                            TypeNameDescription
                                                                                            GraphViewgraph
                                                                                            RectdrawBounds
                                                                                            RectangleFgraphBounds
                                                                                            +

                                                                                            Implements

                                                                                            +
                                                                                            + ISeries +
                                                                                            +
                                                                                            +
                                                                                            + + +
                                                                                            +
                                                                                            + + +
                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.Orientation.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.Orientation.html new file mode 100644 index 0000000000..c4410d2457 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.Orientation.html @@ -0,0 +1,152 @@ + + + + + + + + Enum Orientation + + + + + + + + + + + + + + + + +
                                                                                            +
                                                                                            + + + +
                                                                                            + +
                                                                                            +
                                                                                            +
                                                                                            + +
                                                                                            +
                                                                                            Search Results for
                                                                                            +
                                                                                            +

                                                                                            +
                                                                                            +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              + +
                                                                                              + +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              + + +

                                                                                              Enum Orientation +

                                                                                              +
                                                                                              +Direction of an element (horizontal or vertical) +
                                                                                              +
                                                                                              +
                                                                                              Namespace: Terminal.Gui.Graphs
                                                                                              +
                                                                                              Assembly: Terminal.Gui.dll
                                                                                              +
                                                                                              Syntax
                                                                                              +
                                                                                              + 
                                                                                              public enum Orientation
                                                                                              +
                                                                                              +

                                                                                              Fields +

                                                                                              + + + + + + + + + + + + + + + + + +
                                                                                              NameDescription
                                                                                              Horizontal +Left to right +
                                                                                              Vertical +Bottom to top +
                                                                                              +
                                                                                              +
                                                                                              + + +
                                                                                              +
                                                                                              + + +
                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.LineF.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.LineF.html new file mode 100644 index 0000000000..68434f17a1 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.LineF.html @@ -0,0 +1,243 @@ + + + + + + + + Class PathAnnotation.LineF + + + + + + + + + + + + + + + + +
                                                                                              +
                                                                                              + + + +
                                                                                              + +
                                                                                              +
                                                                                              +
                                                                                              + +
                                                                                              +
                                                                                              Search Results for
                                                                                              +
                                                                                              +

                                                                                              +
                                                                                              +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                + +
                                                                                                + +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                + + +

                                                                                                Class PathAnnotation.LineF +

                                                                                                +
                                                                                                +Describes two points in graph space and a line between them +
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                Inheritance
                                                                                                +
                                                                                                System.Object
                                                                                                +
                                                                                                PathAnnotation.LineF
                                                                                                +
                                                                                                +
                                                                                                +
                                                                                                Inherited Members
                                                                                                +
                                                                                                + System.Object.Equals(System.Object) +
                                                                                                +
                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                +
                                                                                                + System.Object.GetHashCode() +
                                                                                                +
                                                                                                + System.Object.GetType() +
                                                                                                +
                                                                                                + System.Object.MemberwiseClone() +
                                                                                                +
                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                +
                                                                                                + System.Object.ToString() +
                                                                                                +
                                                                                                +
                                                                                                Namespace: Terminal.Gui.Graphs
                                                                                                +
                                                                                                Assembly: Terminal.Gui.dll
                                                                                                +
                                                                                                Syntax
                                                                                                +
                                                                                                + 
                                                                                                public class LineF
                                                                                                +
                                                                                                +

                                                                                                Constructors +

                                                                                                + +

                                                                                                LineF(PointF, PointF)

                                                                                                +
                                                                                                +Creates a new line between the points +
                                                                                                +
                                                                                                +
                                                                                                Declaration
                                                                                                +
                                                                                                + 
                                                                                                public LineF(PointF start, PointF end)
                                                                                                +
                                                                                                +
                                                                                                Parameters
                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                TypeNameDescription
                                                                                                PointFstart
                                                                                                PointFend
                                                                                                +

                                                                                                Properties +

                                                                                                + +

                                                                                                End

                                                                                                +
                                                                                                +The end point of the line +
                                                                                                +
                                                                                                +
                                                                                                Declaration
                                                                                                +
                                                                                                + 
                                                                                                public PointF End { get; }
                                                                                                +
                                                                                                +
                                                                                                Property Value
                                                                                                + + + + + + + + + + + + + +
                                                                                                TypeDescription
                                                                                                PointF
                                                                                                + +

                                                                                                Start

                                                                                                +
                                                                                                +The start of the line +
                                                                                                +
                                                                                                +
                                                                                                Declaration
                                                                                                +
                                                                                                + 
                                                                                                public PointF Start { get; }
                                                                                                +
                                                                                                +
                                                                                                Property Value
                                                                                                + + + + + + + + + + + + + +
                                                                                                TypeDescription
                                                                                                PointF
                                                                                                +
                                                                                                +
                                                                                                + + +
                                                                                                +
                                                                                                + + +
                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.html new file mode 100644 index 0000000000..37c6d426e8 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.html @@ -0,0 +1,297 @@ + + + + + + + + Class PathAnnotation + + + + + + + + + + + + + + + + +
                                                                                                +
                                                                                                + + + +
                                                                                                + +
                                                                                                +
                                                                                                +
                                                                                                + +
                                                                                                +
                                                                                                Search Results for
                                                                                                +
                                                                                                +

                                                                                                +
                                                                                                +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  + +
                                                                                                  + +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  + + +

                                                                                                  Class PathAnnotation +

                                                                                                  +
                                                                                                  +Sequence of lines to connect points e.g. of a ScatterSeries +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  Inheritance
                                                                                                  +
                                                                                                  System.Object
                                                                                                  +
                                                                                                  PathAnnotation
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  Implements
                                                                                                  + +
                                                                                                  +
                                                                                                  +
                                                                                                  Inherited Members
                                                                                                  +
                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                  +
                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                  +
                                                                                                  + System.Object.GetHashCode() +
                                                                                                  +
                                                                                                  + System.Object.GetType() +
                                                                                                  +
                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                  +
                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                  +
                                                                                                  + System.Object.ToString() +
                                                                                                  +
                                                                                                  +
                                                                                                  Namespace: Terminal.Gui.Graphs
                                                                                                  +
                                                                                                  Assembly: Terminal.Gui.dll
                                                                                                  +
                                                                                                  Syntax
                                                                                                  +
                                                                                                  + 
                                                                                                  public class PathAnnotation : IAnnotation
                                                                                                  +
                                                                                                  +

                                                                                                  Properties +

                                                                                                  + +

                                                                                                  BeforeSeries

                                                                                                  +
                                                                                                  +True to add line before plotting series. Defaults to false +
                                                                                                  +
                                                                                                  +
                                                                                                  Declaration
                                                                                                  +
                                                                                                  + 
                                                                                                  public bool BeforeSeries { get; set; }
                                                                                                  +
                                                                                                  +
                                                                                                  Property Value
                                                                                                  + + + + + + + + + + + + + +
                                                                                                  TypeDescription
                                                                                                  System.Boolean
                                                                                                  + +

                                                                                                  LineColor

                                                                                                  +
                                                                                                  +Color for the line that connects points +
                                                                                                  +
                                                                                                  +
                                                                                                  Declaration
                                                                                                  +
                                                                                                  + 
                                                                                                  public Attribute? LineColor { get; set; }
                                                                                                  +
                                                                                                  +
                                                                                                  Property Value
                                                                                                  + + + + + + + + + + + + + +
                                                                                                  TypeDescription
                                                                                                  System.Nullable<Attribute>
                                                                                                  + +

                                                                                                  LineRune

                                                                                                  +
                                                                                                  +The symbol that gets drawn along the line, defaults to '.' +
                                                                                                  +
                                                                                                  +
                                                                                                  Declaration
                                                                                                  +
                                                                                                  + 
                                                                                                  public Rune LineRune { get; set; }
                                                                                                  +
                                                                                                  +
                                                                                                  Property Value
                                                                                                  + + + + + + + + + + + + + +
                                                                                                  TypeDescription
                                                                                                  System.Rune
                                                                                                  + +

                                                                                                  Points

                                                                                                  +
                                                                                                  +Points that should be connected. Lines will be drawn between points in the order +they appear in the list +
                                                                                                  +
                                                                                                  +
                                                                                                  Declaration
                                                                                                  +
                                                                                                  + 
                                                                                                  public List<PointF> Points { get; set; }
                                                                                                  +
                                                                                                  +
                                                                                                  Property Value
                                                                                                  + + + + + + + + + + + + + +
                                                                                                  TypeDescription
                                                                                                  System.Collections.Generic.List<PointF>
                                                                                                  +

                                                                                                  Methods +

                                                                                                  + +

                                                                                                  Render(GraphView)

                                                                                                  +
                                                                                                  +Draws lines connecting each of the Points +
                                                                                                  +
                                                                                                  +
                                                                                                  Declaration
                                                                                                  +
                                                                                                  + 
                                                                                                  public void Render(GraphView graph)
                                                                                                  +
                                                                                                  +
                                                                                                  Parameters
                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                  TypeNameDescription
                                                                                                  GraphViewgraph
                                                                                                  +

                                                                                                  Implements

                                                                                                  + +
                                                                                                  +
                                                                                                  + + +
                                                                                                  +
                                                                                                  + + +
                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.ScatterSeries.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.ScatterSeries.html new file mode 100644 index 0000000000..b03148c193 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.ScatterSeries.html @@ -0,0 +1,258 @@ + + + + + + + + Class ScatterSeries + + + + + + + + + + + + + + + + +
                                                                                                  +
                                                                                                  + + + +
                                                                                                  + +
                                                                                                  +
                                                                                                  +
                                                                                                  + +
                                                                                                  +
                                                                                                  Search Results for
                                                                                                  +
                                                                                                  +

                                                                                                  +
                                                                                                  +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    + +
                                                                                                    + +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    + + +

                                                                                                    Class ScatterSeries +

                                                                                                    +
                                                                                                    +Series composed of any number of discrete data points +
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    Inheritance
                                                                                                    +
                                                                                                    System.Object
                                                                                                    +
                                                                                                    ScatterSeries
                                                                                                    +
                                                                                                    +
                                                                                                    +
                                                                                                    Implements
                                                                                                    + +
                                                                                                    +
                                                                                                    +
                                                                                                    Inherited Members
                                                                                                    +
                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                    +
                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                    +
                                                                                                    + System.Object.GetHashCode() +
                                                                                                    +
                                                                                                    + System.Object.GetType() +
                                                                                                    +
                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                    +
                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                    +
                                                                                                    + System.Object.ToString() +
                                                                                                    +
                                                                                                    +
                                                                                                    Namespace: Terminal.Gui.Graphs
                                                                                                    +
                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                    +
                                                                                                    Syntax
                                                                                                    +
                                                                                                    + 
                                                                                                    public class ScatterSeries : ISeries
                                                                                                    +
                                                                                                    +

                                                                                                    Properties +

                                                                                                    + +

                                                                                                    Fill

                                                                                                    +
                                                                                                    +The color and character that will be rendered in the console +when there are point(s) in the corresponding graph space. +Defaults to uncolored 'x' +
                                                                                                    +
                                                                                                    +
                                                                                                    Declaration
                                                                                                    +
                                                                                                    + 
                                                                                                    public GraphCellToRender Fill { get; set; }
                                                                                                    +
                                                                                                    +
                                                                                                    Property Value
                                                                                                    + + + + + + + + + + + + + +
                                                                                                    TypeDescription
                                                                                                    GraphCellToRender
                                                                                                    + +

                                                                                                    Points

                                                                                                    +
                                                                                                    +Collection of each discrete point in the series +
                                                                                                    +
                                                                                                    +
                                                                                                    Declaration
                                                                                                    +
                                                                                                    + 
                                                                                                    public List<PointF> Points { get; set; }
                                                                                                    +
                                                                                                    +
                                                                                                    Property Value
                                                                                                    + + + + + + + + + + + + + +
                                                                                                    TypeDescription
                                                                                                    System.Collections.Generic.List<PointF>
                                                                                                    +

                                                                                                    Methods +

                                                                                                    + +

                                                                                                    DrawSeries(GraphView, Rect, RectangleF)

                                                                                                    +
                                                                                                    +Draws all points directly onto the graph +
                                                                                                    +
                                                                                                    +
                                                                                                    Declaration
                                                                                                    +
                                                                                                    + 
                                                                                                    public void DrawSeries(GraphView graph, Rect drawBounds, RectangleF graphBounds)
                                                                                                    +
                                                                                                    +
                                                                                                    Parameters
                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                    TypeNameDescription
                                                                                                    GraphViewgraph
                                                                                                    RectdrawBounds
                                                                                                    RectangleFgraphBounds
                                                                                                    +

                                                                                                    Implements

                                                                                                    +
                                                                                                    + ISeries +
                                                                                                    +
                                                                                                    +
                                                                                                    + + +
                                                                                                    +
                                                                                                    + + +
                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.TextAnnotation.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.TextAnnotation.html new file mode 100644 index 0000000000..375ccab0d2 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.TextAnnotation.html @@ -0,0 +1,338 @@ + + + + + + + + Class TextAnnotation + + + + + + + + + + + + + + + + +
                                                                                                    +
                                                                                                    + + + +
                                                                                                    + +
                                                                                                    +
                                                                                                    +
                                                                                                    + +
                                                                                                    +
                                                                                                    Search Results for
                                                                                                    +
                                                                                                    +

                                                                                                    +
                                                                                                    +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      + +
                                                                                                      + +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      + + +

                                                                                                      Class TextAnnotation +

                                                                                                      +
                                                                                                      +Displays text at a given position (in screen space or graph space) +
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      Inheritance
                                                                                                      +
                                                                                                      System.Object
                                                                                                      +
                                                                                                      TextAnnotation
                                                                                                      +
                                                                                                      +
                                                                                                      +
                                                                                                      Implements
                                                                                                      + +
                                                                                                      +
                                                                                                      +
                                                                                                      Inherited Members
                                                                                                      +
                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                      +
                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                      +
                                                                                                      + System.Object.GetHashCode() +
                                                                                                      +
                                                                                                      + System.Object.GetType() +
                                                                                                      +
                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                      +
                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                      +
                                                                                                      + System.Object.ToString() +
                                                                                                      +
                                                                                                      +
                                                                                                      Namespace: Terminal.Gui.Graphs
                                                                                                      +
                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                      +
                                                                                                      Syntax
                                                                                                      +
                                                                                                      + 
                                                                                                      public class TextAnnotation : IAnnotation
                                                                                                      +
                                                                                                      +

                                                                                                      Properties +

                                                                                                      + +

                                                                                                      BeforeSeries

                                                                                                      +
                                                                                                      +True to add text before plotting series. Defaults to false +
                                                                                                      +
                                                                                                      +
                                                                                                      Declaration
                                                                                                      +
                                                                                                      + 
                                                                                                      public bool BeforeSeries { get; set; }
                                                                                                      +
                                                                                                      +
                                                                                                      Property Value
                                                                                                      + + + + + + + + + + + + + +
                                                                                                      TypeDescription
                                                                                                      System.Boolean
                                                                                                      + +

                                                                                                      GraphPosition

                                                                                                      +
                                                                                                      +The location in graph space to draw the Text. This +annotation will only show if the point is in the current viewable +area of the graph presented in the GraphView +
                                                                                                      +
                                                                                                      +
                                                                                                      Declaration
                                                                                                      +
                                                                                                      + 
                                                                                                      public PointF GraphPosition { get; set; }
                                                                                                      +
                                                                                                      +
                                                                                                      Property Value
                                                                                                      + + + + + + + + + + + + + +
                                                                                                      TypeDescription
                                                                                                      PointF
                                                                                                      + +

                                                                                                      ScreenPosition

                                                                                                      +
                                                                                                      +The location on screen to draw the Text regardless +of scroll/zoom settings. This overrides GraphPosition +if specified. +
                                                                                                      +
                                                                                                      +
                                                                                                      Declaration
                                                                                                      +
                                                                                                      + 
                                                                                                      public Point? ScreenPosition { get; set; }
                                                                                                      +
                                                                                                      +
                                                                                                      Property Value
                                                                                                      + + + + + + + + + + + + + +
                                                                                                      TypeDescription
                                                                                                      System.Nullable<Point>
                                                                                                      + +

                                                                                                      Text

                                                                                                      +
                                                                                                      +Text to display on the graph +
                                                                                                      +
                                                                                                      +
                                                                                                      Declaration
                                                                                                      +
                                                                                                      + 
                                                                                                      public string Text { get; set; }
                                                                                                      +
                                                                                                      +
                                                                                                      Property Value
                                                                                                      + + + + + + + + + + + + + +
                                                                                                      TypeDescription
                                                                                                      System.String
                                                                                                      +

                                                                                                      Methods +

                                                                                                      + +

                                                                                                      DrawText(GraphView, Int32, Int32)

                                                                                                      +
                                                                                                      +Draws the Text at the given coordinates with truncation to avoid +spilling over of the graph +
                                                                                                      +
                                                                                                      +
                                                                                                      Declaration
                                                                                                      +
                                                                                                      + 
                                                                                                      protected void DrawText(GraphView graph, int x, int y)
                                                                                                      +
                                                                                                      +
                                                                                                      Parameters
                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                      TypeNameDescription
                                                                                                      GraphViewgraph
                                                                                                      System.Int32xScreen x position to start drawing string
                                                                                                      System.Int32yScreen y position to start drawing string
                                                                                                      + +

                                                                                                      Render(GraphView)

                                                                                                      +
                                                                                                      +Draws the annotation +
                                                                                                      +
                                                                                                      +
                                                                                                      Declaration
                                                                                                      +
                                                                                                      + 
                                                                                                      public void Render(GraphView graph)
                                                                                                      +
                                                                                                      +
                                                                                                      Parameters
                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                      TypeNameDescription
                                                                                                      GraphViewgraph
                                                                                                      +

                                                                                                      Implements

                                                                                                      + +
                                                                                                      +
                                                                                                      + + +
                                                                                                      +
                                                                                                      + + +
                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.VerticalAxis.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.VerticalAxis.html new file mode 100644 index 0000000000..bad0b7162f --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.VerticalAxis.html @@ -0,0 +1,379 @@ + + + + + + + + Class VerticalAxis + + + + + + + + + + + + + + + + +
                                                                                                      +
                                                                                                      + + + +
                                                                                                      + +
                                                                                                      +
                                                                                                      +
                                                                                                      + +
                                                                                                      +
                                                                                                      Search Results for
                                                                                                      +
                                                                                                      +

                                                                                                      +
                                                                                                      +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        + +
                                                                                                        + +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        + + +

                                                                                                        Class VerticalAxis +

                                                                                                        +
                                                                                                        +The vertical (i.e. Y axis) of a GraphView +
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        Inheritance
                                                                                                        +
                                                                                                        System.Object
                                                                                                        +
                                                                                                        Axis
                                                                                                        +
                                                                                                        VerticalAxis
                                                                                                        +
                                                                                                        +
                                                                                                        +
                                                                                                        Inherited Members
                                                                                                        + + + + + +
                                                                                                        + Axis.Text +
                                                                                                        + + +
                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                        +
                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                        +
                                                                                                        + System.Object.GetHashCode() +
                                                                                                        +
                                                                                                        + System.Object.GetType() +
                                                                                                        +
                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                        +
                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                        +
                                                                                                        + System.Object.ToString() +
                                                                                                        +
                                                                                                        +
                                                                                                        Namespace: Terminal.Gui.Graphs
                                                                                                        +
                                                                                                        Assembly: Terminal.Gui.dll
                                                                                                        +
                                                                                                        Syntax
                                                                                                        +
                                                                                                        + 
                                                                                                        public class VerticalAxis : Axis
                                                                                                        +
                                                                                                        +

                                                                                                        Constructors +

                                                                                                        + +

                                                                                                        VerticalAxis()

                                                                                                        +
                                                                                                        +Creates a new Vertical axis +
                                                                                                        +
                                                                                                        +
                                                                                                        Declaration
                                                                                                        +
                                                                                                        + 
                                                                                                        public VerticalAxis()
                                                                                                        +
                                                                                                        +

                                                                                                        Methods +

                                                                                                        + +

                                                                                                        DrawAxisLabel(GraphView, Int32, String)

                                                                                                        +
                                                                                                        +Draws the given text on the axis at y screenPosition. +For the screen x position use GetAxisXPosition(GraphView) +
                                                                                                        +
                                                                                                        +
                                                                                                        Declaration
                                                                                                        +
                                                                                                        + 
                                                                                                        public override void DrawAxisLabel(GraphView graph, int screenPosition, string text)
                                                                                                        +
                                                                                                        +
                                                                                                        Parameters
                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                        TypeNameDescription
                                                                                                        GraphViewgraphGraph being drawn onto
                                                                                                        System.Int32screenPositionNumber of rows from the top of the screen (i.e. down the axis) before rendering
                                                                                                        System.StringtextText to render to the left of the axis tick. Ensure to +set MarginLeft or ScrollOffset sufficient that it is visible
                                                                                                        +
                                                                                                        Overrides
                                                                                                        + + +

                                                                                                        DrawAxisLabels(GraphView)

                                                                                                        +
                                                                                                        +Draws axis Increment markers and labels +
                                                                                                        +
                                                                                                        +
                                                                                                        Declaration
                                                                                                        +
                                                                                                        + 
                                                                                                        public override void DrawAxisLabels(GraphView graph)
                                                                                                        +
                                                                                                        +
                                                                                                        Parameters
                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                        TypeNameDescription
                                                                                                        GraphViewgraph
                                                                                                        +
                                                                                                        Overrides
                                                                                                        + + +

                                                                                                        DrawAxisLine(GraphView)

                                                                                                        +
                                                                                                        +Draws the vertical axis line +
                                                                                                        +
                                                                                                        +
                                                                                                        Declaration
                                                                                                        +
                                                                                                        + 
                                                                                                        public override void DrawAxisLine(GraphView graph)
                                                                                                        +
                                                                                                        +
                                                                                                        Parameters
                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                        TypeNameDescription
                                                                                                        GraphViewgraph
                                                                                                        +
                                                                                                        Overrides
                                                                                                        + + +

                                                                                                        DrawAxisLine(GraphView, Int32, Int32)

                                                                                                        +
                                                                                                        +Draws a vertical axis line at the given x, y +screen coordinates +
                                                                                                        +
                                                                                                        +
                                                                                                        Declaration
                                                                                                        +
                                                                                                        + 
                                                                                                        protected override void DrawAxisLine(GraphView graph, int x, int y)
                                                                                                        +
                                                                                                        +
                                                                                                        Parameters
                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                        TypeNameDescription
                                                                                                        GraphViewgraph
                                                                                                        System.Int32x
                                                                                                        System.Int32y
                                                                                                        +
                                                                                                        Overrides
                                                                                                        + + +

                                                                                                        GetAxisXPosition(GraphView)

                                                                                                        +
                                                                                                        +Returns the X screen position of the origin (typically 0,0) of graph space. +Return value is bounded by the screen i.e. the axis is always rendered even +if the origin is offscreen. +
                                                                                                        +
                                                                                                        +
                                                                                                        Declaration
                                                                                                        +
                                                                                                        + 
                                                                                                        public int GetAxisXPosition(GraphView graph)
                                                                                                        +
                                                                                                        +
                                                                                                        Parameters
                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                        TypeNameDescription
                                                                                                        GraphViewgraph
                                                                                                        +
                                                                                                        Returns
                                                                                                        + + + + + + + + + + + + + +
                                                                                                        TypeDescription
                                                                                                        System.Int32
                                                                                                        +
                                                                                                        +
                                                                                                        + + +
                                                                                                        +
                                                                                                        + + +
                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Graphs.html b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.html new file mode 100644 index 0000000000..9162a5e907 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Graphs.html @@ -0,0 +1,207 @@ + + + + + + + + Namespace Terminal.Gui.Graphs + + + + + + + + + + + + + + + + +
                                                                                                        +
                                                                                                        + + + +
                                                                                                        + +
                                                                                                        +
                                                                                                        +
                                                                                                        + +
                                                                                                        +
                                                                                                        Search Results for
                                                                                                        +
                                                                                                        +

                                                                                                        +
                                                                                                        +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          + +
                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          + +

                                                                                                          Namespace Terminal.Gui.Graphs +

                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          Classes +

                                                                                                          +

                                                                                                          Axis

                                                                                                          +
                                                                                                          +Renders a continuous line with grid line ticks and labels +
                                                                                                          +

                                                                                                          AxisIncrementToRender

                                                                                                          +
                                                                                                          +A location on an axis of a GraphView that may +or may not have a label associated with it +
                                                                                                          +

                                                                                                          BarSeries

                                                                                                          +
                                                                                                          +Series of bars positioned at regular intervals +
                                                                                                          +

                                                                                                          BarSeries.Bar

                                                                                                          +
                                                                                                          +A single bar in a BarSeries +
                                                                                                          +

                                                                                                          GraphCellToRender

                                                                                                          +
                                                                                                          +Describes how to render a single row/column of a GraphView based +on the value(s) in ISeries at that location +
                                                                                                          +

                                                                                                          HorizontalAxis

                                                                                                          +
                                                                                                          +The horizontal (x axis) of a GraphView +
                                                                                                          +

                                                                                                          LegendAnnotation

                                                                                                          +
                                                                                                          +A box containing symbol definitions e.g. meanings for colors in a graph. +The 'Key' to the graph +
                                                                                                          +

                                                                                                          MultiBarSeries

                                                                                                          +
                                                                                                          +Collection of BarSeries in which bars are clustered by category +
                                                                                                          +

                                                                                                          PathAnnotation

                                                                                                          +
                                                                                                          +Sequence of lines to connect points e.g. of a ScatterSeries +
                                                                                                          +

                                                                                                          PathAnnotation.LineF

                                                                                                          +
                                                                                                          +Describes two points in graph space and a line between them +
                                                                                                          +

                                                                                                          ScatterSeries

                                                                                                          +
                                                                                                          +Series composed of any number of discrete data points +
                                                                                                          +

                                                                                                          TextAnnotation

                                                                                                          +
                                                                                                          +Displays text at a given position (in screen space or graph space) +
                                                                                                          +

                                                                                                          VerticalAxis

                                                                                                          +
                                                                                                          +The vertical (i.e. Y axis) of a GraphView +
                                                                                                          +

                                                                                                          Interfaces +

                                                                                                          +

                                                                                                          IAnnotation

                                                                                                          +
                                                                                                          +

                                                                                                          Describes an overlay element that is rendered either before or +after a series.

                                                                                                          + +

                                                                                                          Annotations can be positioned either in screen space (e.g. +a legend) or in graph space (e.g. a line showing high point) +

                                                                                                          +

                                                                                                          Unlike ISeries, annotations are allowed to +draw into graph margins +

                                                                                                          +
                                                                                                          +

                                                                                                          ISeries

                                                                                                          +
                                                                                                          +Describes a series of data that can be rendered into a GraphView> +
                                                                                                          +

                                                                                                          Enums +

                                                                                                          +

                                                                                                          Orientation

                                                                                                          +
                                                                                                          +Direction of an element (horizontal or vertical) +
                                                                                                          +

                                                                                                          Delegates +

                                                                                                          +

                                                                                                          LabelGetterDelegate

                                                                                                          +
                                                                                                          +Delegate for custom formatting of axis labels. Determines what should be displayed at a given label +
                                                                                                          +
                                                                                                          +
                                                                                                          + + +
                                                                                                          +
                                                                                                          + + +
                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.HexView.HexViewEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.HexView.HexViewEventArgs.html new file mode 100644 index 0000000000..664f53362a --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.HexView.HexViewEventArgs.html @@ -0,0 +1,277 @@ + + + + + + + + Class HexView.HexViewEventArgs + + + + + + + + + + + + + + + + +
                                                                                                          +
                                                                                                          + + + +
                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          Search Results for
                                                                                                          +
                                                                                                          +

                                                                                                          +
                                                                                                          +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            + +
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            + + +

                                                                                                            Class HexView.HexViewEventArgs +

                                                                                                            +
                                                                                                            +Defines the event arguments for PositionChanged event. +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            Inheritance
                                                                                                            +
                                                                                                            System.Object
                                                                                                            +
                                                                                                            System.EventArgs
                                                                                                            +
                                                                                                            HexView.HexViewEventArgs
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            Inherited Members
                                                                                                            +
                                                                                                            + System.EventArgs.Empty +
                                                                                                            +
                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                            +
                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                            +
                                                                                                            + System.Object.GetHashCode() +
                                                                                                            +
                                                                                                            + System.Object.GetType() +
                                                                                                            +
                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                            +
                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                            +
                                                                                                            + System.Object.ToString() +
                                                                                                            +
                                                                                                            +
                                                                                                            Namespace: Terminal.Gui
                                                                                                            +
                                                                                                            Assembly: Terminal.Gui.dll
                                                                                                            +
                                                                                                            Syntax
                                                                                                            +
                                                                                                            + 
                                                                                                            public class HexViewEventArgs : EventArgs
                                                                                                            +
                                                                                                            +

                                                                                                            Constructors +

                                                                                                            + +

                                                                                                            HexViewEventArgs(Int64, Point, Int32)

                                                                                                            +
                                                                                                            +Initializes a new instance of HexView.HexViewEventArgs +
                                                                                                            +
                                                                                                            +
                                                                                                            Declaration
                                                                                                            +
                                                                                                            + 
                                                                                                            public HexViewEventArgs(long pos, Point cursor, int lineLength)
                                                                                                            +
                                                                                                            +
                                                                                                            Parameters
                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                            TypeNameDescription
                                                                                                            System.Int64posThe character position.
                                                                                                            PointcursorThe cursor position.
                                                                                                            System.Int32lineLengthLine bytes length.
                                                                                                            +

                                                                                                            Properties +

                                                                                                            + +

                                                                                                            BytesPerLine

                                                                                                            +
                                                                                                            +The bytes length per line. +
                                                                                                            +
                                                                                                            +
                                                                                                            Declaration
                                                                                                            +
                                                                                                            + 
                                                                                                            public int BytesPerLine { get; }
                                                                                                            +
                                                                                                            +
                                                                                                            Property Value
                                                                                                            + + + + + + + + + + + + + +
                                                                                                            TypeDescription
                                                                                                            System.Int32
                                                                                                            + +

                                                                                                            CursorPosition

                                                                                                            +
                                                                                                            +Gets the current cursor position starting at one for both, line and column. +
                                                                                                            +
                                                                                                            +
                                                                                                            Declaration
                                                                                                            +
                                                                                                            + 
                                                                                                            public Point CursorPosition { get; }
                                                                                                            +
                                                                                                            +
                                                                                                            Property Value
                                                                                                            + + + + + + + + + + + + + +
                                                                                                            TypeDescription
                                                                                                            Point
                                                                                                            + +

                                                                                                            Position

                                                                                                            +
                                                                                                            +Gets the current character position starting at one, related to the System.IO.Stream. +
                                                                                                            +
                                                                                                            +
                                                                                                            Declaration
                                                                                                            +
                                                                                                            + 
                                                                                                            public long Position { get; }
                                                                                                            +
                                                                                                            +
                                                                                                            Property Value
                                                                                                            + + + + + + + + + + + + + +
                                                                                                            TypeDescription
                                                                                                            System.Int64
                                                                                                            +
                                                                                                            +
                                                                                                            + + +
                                                                                                            +
                                                                                                            + + +
                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.HexView.html b/docs/api/Terminal.Gui/Terminal.Gui.HexView.html new file mode 100644 index 0000000000..66dc90de9d --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.HexView.html @@ -0,0 +1,1155 @@ + + + + + + + + Class HexView + + + + + + + + + + + + + + + + +
                                                                                                            +
                                                                                                            + + + +
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            + +
                                                                                                            +
                                                                                                            Search Results for
                                                                                                            +
                                                                                                            +

                                                                                                            +
                                                                                                            +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              + +
                                                                                                              + +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              + + +

                                                                                                              Class HexView +

                                                                                                              +
                                                                                                              +An hex viewer and editor View over a System.IO.Stream +
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              Inheritance
                                                                                                              +
                                                                                                              System.Object
                                                                                                              +
                                                                                                              Responder
                                                                                                              +
                                                                                                              View
                                                                                                              +
                                                                                                              HexView
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              Implements
                                                                                                              +
                                                                                                              System.IDisposable
                                                                                                              +
                                                                                                              System.ComponentModel.ISupportInitializeNotification
                                                                                                              +
                                                                                                              System.ComponentModel.ISupportInitialize
                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              Inherited Members
                                                                                                              + + + + + + + + + + + + + + + + +
                                                                                                              + View.Data +
                                                                                                              + + + + + + +
                                                                                                              + View.Id +
                                                                                                              + + + + + +
                                                                                                              + View.X +
                                                                                                              +
                                                                                                              + View.Y +
                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                              + View.Text +
                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                              +
                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                              +
                                                                                                              + System.Object.GetHashCode() +
                                                                                                              +
                                                                                                              + System.Object.GetType() +
                                                                                                              +
                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                              +
                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                              +
                                                                                                              +
                                                                                                              Namespace: Terminal.Gui
                                                                                                              +
                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                              +
                                                                                                              Syntax
                                                                                                              +
                                                                                                              + 
                                                                                                              public class HexView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                              +
                                                                                                              +
                                                                                                              Remarks
                                                                                                              +
                                                                                                              +

                                                                                                              +HexView provides a hex editor on top of a seekable System.IO.Stream with the left side showing an hex +dump of the values in the System.IO.Stream and the right side showing the contents (filtered to +non-control sequence ASCII characters). +

                                                                                                              +

                                                                                                              +Users can switch from one side to the other by using the tab key. +

                                                                                                              +

                                                                                                              +To enable editing, set AllowEdits to true. When AllowEdits is true +the user can make changes to the hexadecimal values of the System.IO.Stream. Any changes are tracked +in the Edits property (a System.Collections.Generic.SortedDictionary`2) indicating +the position where the changes were made and the new values. A convenience method, ApplyEdits(Stream) +will apply the edits to the System.IO.Stream. +

                                                                                                              +

                                                                                                              +Control the first byte shown by setting the DisplayStart property +to an offset in the stream. +

                                                                                                              +
                                                                                                              +

                                                                                                              Constructors +

                                                                                                              + +

                                                                                                              HexView()

                                                                                                              +
                                                                                                              +Initializes a HexView class using Computed layout. +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public HexView()
                                                                                                              +
                                                                                                              + +

                                                                                                              HexView(Stream)

                                                                                                              +
                                                                                                              +Initializes a HexView class using Computed layout. +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public HexView(Stream source)
                                                                                                              +
                                                                                                              +
                                                                                                              Parameters
                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                              TypeNameDescription
                                                                                                              System.IO.StreamsourceThe System.IO.Stream to view and edit as hex, this System.IO.Stream must support seeking, or an exception will be thrown.
                                                                                                              +

                                                                                                              Properties +

                                                                                                              + +

                                                                                                              AllowEdits

                                                                                                              +
                                                                                                              +Gets or sets whether this HexView allow editing of the System.IO.Stream +of the underlying System.IO.Stream. +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public bool AllowEdits { get; set; }
                                                                                                              +
                                                                                                              +
                                                                                                              Property Value
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              TypeDescription
                                                                                                              System.Booleantrue if allow edits; otherwise, false.
                                                                                                              + +

                                                                                                              BytesPerLine

                                                                                                              +
                                                                                                              +The bytes length per line. +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public int BytesPerLine { get; }
                                                                                                              +
                                                                                                              +
                                                                                                              Property Value
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              TypeDescription
                                                                                                              System.Int32
                                                                                                              + +

                                                                                                              CursorPosition

                                                                                                              +
                                                                                                              +Gets the current cursor position starting at one for both, line and column. +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public Point CursorPosition { get; }
                                                                                                              +
                                                                                                              +
                                                                                                              Property Value
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              TypeDescription
                                                                                                              Point
                                                                                                              + +

                                                                                                              DesiredCursorVisibility

                                                                                                              +
                                                                                                              +Get / Set the wished cursor when the field is focused +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public CursorVisibility DesiredCursorVisibility { get; set; }
                                                                                                              +
                                                                                                              +
                                                                                                              Property Value
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              TypeDescription
                                                                                                              CursorVisibility
                                                                                                              + +

                                                                                                              DisplayStart

                                                                                                              +
                                                                                                              +Sets or gets the offset into the System.IO.Stream that will displayed at the top of the HexView +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public long DisplayStart { get; set; }
                                                                                                              +
                                                                                                              +
                                                                                                              Property Value
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              TypeDescription
                                                                                                              System.Int64The display start.
                                                                                                              + +

                                                                                                              Edits

                                                                                                              +
                                                                                                              +Gets a System.Collections.Generic.SortedDictionary`2 describing the edits done to the HexView. +Each Key indicates an offset where an edit was made and the Value is the changed byte. +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public IReadOnlyDictionary<long, byte> Edits { get; }
                                                                                                              +
                                                                                                              +
                                                                                                              Property Value
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              TypeDescription
                                                                                                              System.Collections.Generic.IReadOnlyDictionary<System.Int64, System.Byte>The edits.
                                                                                                              + +

                                                                                                              Frame

                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public override Rect Frame { get; set; }
                                                                                                              +
                                                                                                              +
                                                                                                              Property Value
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              TypeDescription
                                                                                                              Rect
                                                                                                              +
                                                                                                              Overrides
                                                                                                              + + +

                                                                                                              Position

                                                                                                              +
                                                                                                              +Gets the current character position starting at one, related to the System.IO.Stream. +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public long Position { get; }
                                                                                                              +
                                                                                                              +
                                                                                                              Property Value
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              TypeDescription
                                                                                                              System.Int64
                                                                                                              + +

                                                                                                              Source

                                                                                                              +
                                                                                                              +Sets or gets the System.IO.Stream the HexView is operating on; the stream must support seeking (System.IO.Stream.CanSeek == true). +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public Stream Source { get; set; }
                                                                                                              +
                                                                                                              +
                                                                                                              Property Value
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              TypeDescription
                                                                                                              System.IO.StreamThe source.
                                                                                                              +

                                                                                                              Methods +

                                                                                                              + +

                                                                                                              ApplyEdits(Stream)

                                                                                                              +
                                                                                                              +This method applies and edits made to the System.IO.Stream and resets the +contents of the Edits property. +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public void ApplyEdits(Stream stream = null)
                                                                                                              +
                                                                                                              +
                                                                                                              Parameters
                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                              TypeNameDescription
                                                                                                              System.IO.StreamstreamIf provided also applies the changes to the passed System.IO.Stream
                                                                                                              + +

                                                                                                              DiscardEdits()

                                                                                                              +
                                                                                                              +This method discards the edits made to the System.IO.Stream by resetting the +contents of the Edits property. +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public void DiscardEdits()
                                                                                                              +
                                                                                                              + +

                                                                                                              MouseEvent(MouseEvent)

                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public override bool MouseEvent(MouseEvent me)
                                                                                                              +
                                                                                                              +
                                                                                                              Parameters
                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                              TypeNameDescription
                                                                                                              MouseEventme
                                                                                                              +
                                                                                                              Returns
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              TypeDescription
                                                                                                              System.Boolean
                                                                                                              +
                                                                                                              Overrides
                                                                                                              + + +

                                                                                                              OnEdited(KeyValuePair<Int64, Byte>)

                                                                                                              +
                                                                                                              +Method used to invoke the Edited event passing the System.Collections.Generic.KeyValuePair<TKey, TValue>. +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public virtual void OnEdited(KeyValuePair<long, byte> keyValuePair)
                                                                                                              +
                                                                                                              +
                                                                                                              Parameters
                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                              TypeNameDescription
                                                                                                              System.Collections.Generic.KeyValuePair<System.Int64, System.Byte>keyValuePairThe key value pair.
                                                                                                              + +

                                                                                                              OnEnter(View)

                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public override bool OnEnter(View view)
                                                                                                              +
                                                                                                              +
                                                                                                              Parameters
                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                              TypeNameDescription
                                                                                                              Viewview
                                                                                                              +
                                                                                                              Returns
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              TypeDescription
                                                                                                              System.Boolean
                                                                                                              +
                                                                                                              Overrides
                                                                                                              + + +

                                                                                                              OnPositionChanged()

                                                                                                              +
                                                                                                              +Method used to invoke the PositionChanged event passing the HexView.HexViewEventArgs arguments. +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public virtual void OnPositionChanged()
                                                                                                              +
                                                                                                              + +

                                                                                                              PositionCursor()

                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public override void PositionCursor()
                                                                                                              +
                                                                                                              +
                                                                                                              Overrides
                                                                                                              + + +

                                                                                                              ProcessKey(KeyEvent)

                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public override bool ProcessKey(KeyEvent keyEvent)
                                                                                                              +
                                                                                                              +
                                                                                                              Parameters
                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                              TypeNameDescription
                                                                                                              KeyEventkeyEvent
                                                                                                              +
                                                                                                              Returns
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              TypeDescription
                                                                                                              System.Boolean
                                                                                                              +
                                                                                                              Overrides
                                                                                                              + + +

                                                                                                              Redraw(Rect)

                                                                                                              +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public override void Redraw(Rect bounds)
                                                                                                              +
                                                                                                              +
                                                                                                              Parameters
                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                              TypeNameDescription
                                                                                                              Rectbounds
                                                                                                              +
                                                                                                              Overrides
                                                                                                              + +

                                                                                                              Events +

                                                                                                              +

                                                                                                              Edited

                                                                                                              +
                                                                                                              +Event to be invoked when an edit is made on the System.IO.Stream. +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public event Action<KeyValuePair<long, byte>> Edited
                                                                                                              +
                                                                                                              +
                                                                                                              Event Type
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              TypeDescription
                                                                                                              System.Action<System.Collections.Generic.KeyValuePair<System.Int64, System.Byte>>
                                                                                                              +

                                                                                                              PositionChanged

                                                                                                              +
                                                                                                              +Event to be invoked when the position and cursor position changes. +
                                                                                                              +
                                                                                                              +
                                                                                                              Declaration
                                                                                                              +
                                                                                                              + 
                                                                                                              public event Action<HexView.HexViewEventArgs> PositionChanged
                                                                                                              +
                                                                                                              +
                                                                                                              Event Type
                                                                                                              + + + + + + + + + + + + + +
                                                                                                              TypeDescription
                                                                                                              System.Action<HexView.HexViewEventArgs>
                                                                                                              +

                                                                                                              Implements

                                                                                                              +
                                                                                                              + System.IDisposable +
                                                                                                              +
                                                                                                              + System.ComponentModel.ISupportInitializeNotification +
                                                                                                              +
                                                                                                              + System.ComponentModel.ISupportInitialize +
                                                                                                              +
                                                                                                              +
                                                                                                              + + +
                                                                                                              +
                                                                                                              + + +
                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.IAutocomplete.html b/docs/api/Terminal.Gui/Terminal.Gui.IAutocomplete.html new file mode 100644 index 0000000000..0a554e6c8e --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.IAutocomplete.html @@ -0,0 +1,577 @@ + + + + + + + + Interface IAutocomplete + + + + + + + + + + + + + + + + +
                                                                                                              +
                                                                                                              + + + +
                                                                                                              + +
                                                                                                              +
                                                                                                              +
                                                                                                              + +
                                                                                                              +
                                                                                                              Search Results for
                                                                                                              +
                                                                                                              +

                                                                                                              +
                                                                                                              +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                + +
                                                                                                                + +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                +
                                                                                                                + + +

                                                                                                                Interface IAutocomplete +

                                                                                                                +
                                                                                                                +Renders an overlay on another view at a given point that allows selecting +from a range of 'autocomplete' options. +
                                                                                                                +
                                                                                                                +
                                                                                                                Namespace: Terminal.Gui
                                                                                                                +
                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                +
                                                                                                                Syntax
                                                                                                                +
                                                                                                                + 
                                                                                                                public interface IAutocomplete
                                                                                                                +
                                                                                                                +

                                                                                                                Properties +

                                                                                                                + +

                                                                                                                AllSuggestions

                                                                                                                +
                                                                                                                +The full set of all strings that can be suggested. +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                List<string> AllSuggestions { get; set; }
                                                                                                                +
                                                                                                                +
                                                                                                                Property Value
                                                                                                                + + + + + + + + + + + + + +
                                                                                                                TypeDescription
                                                                                                                System.Collections.Generic.List<System.String>
                                                                                                                + +

                                                                                                                CloseKey

                                                                                                                +
                                                                                                                +The key that the user can press to close the currently popped autocomplete menu +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                Key CloseKey { get; set; }
                                                                                                                +
                                                                                                                +
                                                                                                                Property Value
                                                                                                                + + + + + + + + + + + + + +
                                                                                                                TypeDescription
                                                                                                                Key
                                                                                                                + +

                                                                                                                ColorScheme

                                                                                                                +
                                                                                                                +The colors to use to render the overlay. Accessing this property before +the Application has been initialized will cause an error +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                ColorScheme ColorScheme { get; set; }
                                                                                                                +
                                                                                                                +
                                                                                                                Property Value
                                                                                                                + + + + + + + + + + + + + +
                                                                                                                TypeDescription
                                                                                                                ColorScheme
                                                                                                                + +

                                                                                                                HostControl

                                                                                                                +
                                                                                                                +The host control that will use autocomplete. +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                View HostControl { get; set; }
                                                                                                                +
                                                                                                                +
                                                                                                                Property Value
                                                                                                                + + + + + + + + + + + + + +
                                                                                                                TypeDescription
                                                                                                                View
                                                                                                                + +

                                                                                                                MaxHeight

                                                                                                                +
                                                                                                                +The maximum number of visible rows in the autocomplete dropdown to render +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                int MaxHeight { get; set; }
                                                                                                                +
                                                                                                                +
                                                                                                                Property Value
                                                                                                                + + + + + + + + + + + + + +
                                                                                                                TypeDescription
                                                                                                                System.Int32
                                                                                                                + +

                                                                                                                MaxWidth

                                                                                                                +
                                                                                                                +The maximum width of the autocomplete dropdown +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                int MaxWidth { get; set; }
                                                                                                                +
                                                                                                                +
                                                                                                                Property Value
                                                                                                                + + + + + + + + + + + + + +
                                                                                                                TypeDescription
                                                                                                                System.Int32
                                                                                                                + +

                                                                                                                PopupInsideContainer

                                                                                                                +
                                                                                                                +Gets or sets where the popup will be displayed. +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                bool PopupInsideContainer { get; set; }
                                                                                                                +
                                                                                                                +
                                                                                                                Property Value
                                                                                                                + + + + + + + + + + + + + +
                                                                                                                TypeDescription
                                                                                                                System.Boolean
                                                                                                                + +

                                                                                                                Reopen

                                                                                                                +
                                                                                                                +The key that the user can press to reopen the currently popped autocomplete menu +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                Key Reopen { get; set; }
                                                                                                                +
                                                                                                                +
                                                                                                                Property Value
                                                                                                                + + + + + + + + + + + + + +
                                                                                                                TypeDescription
                                                                                                                Key
                                                                                                                + +

                                                                                                                SelectedIdx

                                                                                                                +
                                                                                                                +The currently selected index into Suggestions that the user has highlighted +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                int SelectedIdx { get; set; }
                                                                                                                +
                                                                                                                +
                                                                                                                Property Value
                                                                                                                + + + + + + + + + + + + + +
                                                                                                                TypeDescription
                                                                                                                System.Int32
                                                                                                                + +

                                                                                                                SelectionKey

                                                                                                                +
                                                                                                                +The key that the user must press to accept the currently selected autocomplete suggestion +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                Key SelectionKey { get; set; }
                                                                                                                +
                                                                                                                +
                                                                                                                Property Value
                                                                                                                + + + + + + + + + + + + + +
                                                                                                                TypeDescription
                                                                                                                Key
                                                                                                                + +

                                                                                                                Suggestions

                                                                                                                +
                                                                                                                +The strings that form the current list of suggestions to render +based on what the user has typed so far. +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                ReadOnlyCollection<string> Suggestions { get; set; }
                                                                                                                +
                                                                                                                +
                                                                                                                Property Value
                                                                                                                + + + + + + + + + + + + + +
                                                                                                                TypeDescription
                                                                                                                System.Collections.ObjectModel.ReadOnlyCollection<System.String>
                                                                                                                + +

                                                                                                                Visible

                                                                                                                +
                                                                                                                +True if the autocomplete should be considered open and visible +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                bool Visible { get; set; }
                                                                                                                +
                                                                                                                +
                                                                                                                Property Value
                                                                                                                + + + + + + + + + + + + + +
                                                                                                                TypeDescription
                                                                                                                System.Boolean
                                                                                                                +

                                                                                                                Methods +

                                                                                                                + +

                                                                                                                ClearSuggestions()

                                                                                                                +
                                                                                                                +Clears Suggestions +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                void ClearSuggestions()
                                                                                                                +
                                                                                                                + +

                                                                                                                GenerateSuggestions()

                                                                                                                +
                                                                                                                +Populates Suggestions with all strings in AllSuggestions that +match with the current cursor position/text in the HostControl. +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                void GenerateSuggestions()
                                                                                                                +
                                                                                                                + +

                                                                                                                MouseEvent(MouseEvent, Boolean)

                                                                                                                +
                                                                                                                +Handle mouse events before HostControl e.g. to make mouse events like +report/click apply to the autocomplete control instead of changing the cursor position in +the underlying text view. +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                bool MouseEvent(MouseEvent me, bool fromHost = false)
                                                                                                                +
                                                                                                                +
                                                                                                                Parameters
                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                TypeNameDescription
                                                                                                                MouseEventmeThe mouse event.
                                                                                                                System.BooleanfromHostIf was called from the popup or from the host.
                                                                                                                +
                                                                                                                Returns
                                                                                                                + + + + + + + + + + + + + +
                                                                                                                TypeDescription
                                                                                                                System.Booleantrueif the mouse can be handled falseotherwise.
                                                                                                                + +

                                                                                                                ProcessKey(KeyEvent)

                                                                                                                +
                                                                                                                +Handle key events before HostControl e.g. to make key events like +up/down apply to the autocomplete control instead of changing the cursor position in +the underlying text view. +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                bool ProcessKey(KeyEvent kb)
                                                                                                                +
                                                                                                                +
                                                                                                                Parameters
                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                TypeNameDescription
                                                                                                                KeyEventkbThe key event.
                                                                                                                +
                                                                                                                Returns
                                                                                                                + + + + + + + + + + + + + +
                                                                                                                TypeDescription
                                                                                                                System.Booleantrueif the key can be handled falseotherwise.
                                                                                                                + +

                                                                                                                RenderOverlay(Point)

                                                                                                                +
                                                                                                                +Renders the autocomplete dialog inside the given HostControl at the +given point. +
                                                                                                                +
                                                                                                                +
                                                                                                                Declaration
                                                                                                                +
                                                                                                                + 
                                                                                                                void RenderOverlay(Point renderAt)
                                                                                                                +
                                                                                                                +
                                                                                                                Parameters
                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                TypeNameDescription
                                                                                                                PointrenderAt
                                                                                                                +
                                                                                                                +
                                                                                                                + + +
                                                                                                                +
                                                                                                                + + +
                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.IClipboard.html b/docs/api/Terminal.Gui/Terminal.Gui.IClipboard.html new file mode 100644 index 0000000000..178cb2c854 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.IClipboard.html @@ -0,0 +1,323 @@ + + + + + + + + Interface IClipboard + + + + + + + + + + + + + + + + +
                                                                                                                +
                                                                                                                + + + +
                                                                                                                + +
                                                                                                                +
                                                                                                                +
                                                                                                                + +
                                                                                                                +
                                                                                                                Search Results for
                                                                                                                +
                                                                                                                +

                                                                                                                +
                                                                                                                +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  + + +

                                                                                                                  Interface IClipboard +

                                                                                                                  +
                                                                                                                  +Definition to interact with the OS clipboard. +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Namespace: Terminal.Gui
                                                                                                                  +
                                                                                                                  Assembly: Terminal.Gui.dll
                                                                                                                  +
                                                                                                                  Syntax
                                                                                                                  +
                                                                                                                  + 
                                                                                                                  public interface IClipboard
                                                                                                                  +
                                                                                                                  +

                                                                                                                  Properties +

                                                                                                                  + +

                                                                                                                  IsSupported

                                                                                                                  +
                                                                                                                  +Returns true if the environmental dependencies are in place to interact with the OS clipboard. +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Declaration
                                                                                                                  +
                                                                                                                  + 
                                                                                                                  bool IsSupported { get; }
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Property Value
                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                  TypeDescription
                                                                                                                  System.Boolean
                                                                                                                  +

                                                                                                                  Methods +

                                                                                                                  + +

                                                                                                                  GetClipboardData()

                                                                                                                  +
                                                                                                                  +Get the operation system clipboard. +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Declaration
                                                                                                                  +
                                                                                                                  + 
                                                                                                                  string GetClipboardData()
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Returns
                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                  TypeDescription
                                                                                                                  System.String
                                                                                                                  +
                                                                                                                  Exceptions
                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                  TypeCondition
                                                                                                                  System.NotSupportedExceptionThrown if it was not possible to read the clipboard contents.
                                                                                                                  + +

                                                                                                                  SetClipboardData(String)

                                                                                                                  +
                                                                                                                  +Sets the operation system clipboard. +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Declaration
                                                                                                                  +
                                                                                                                  + 
                                                                                                                  void SetClipboardData(string text)
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Parameters
                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                  TypeNameDescription
                                                                                                                  System.Stringtext
                                                                                                                  +
                                                                                                                  Exceptions
                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                  TypeCondition
                                                                                                                  System.NotSupportedExceptionThrown if it was not possible to set the clipboard contents.
                                                                                                                  + +

                                                                                                                  TryGetClipboardData(out String)

                                                                                                                  +
                                                                                                                  +Gets the operation system clipboard if possible. +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Declaration
                                                                                                                  +
                                                                                                                  + 
                                                                                                                  bool TryGetClipboardData(out string result)
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Parameters
                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                  TypeNameDescription
                                                                                                                  System.StringresultClipboard contents read
                                                                                                                  +
                                                                                                                  Returns
                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                  TypeDescription
                                                                                                                  System.Booleantrue if it was possible to read the OS clipboard.
                                                                                                                  + +

                                                                                                                  TrySetClipboardData(String)

                                                                                                                  +
                                                                                                                  +Sets the operation system clipboard if possible. +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Declaration
                                                                                                                  +
                                                                                                                  + 
                                                                                                                  bool TrySetClipboardData(string text)
                                                                                                                  +
                                                                                                                  +
                                                                                                                  Parameters
                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                  TypeNameDescription
                                                                                                                  System.Stringtext
                                                                                                                  +
                                                                                                                  Returns
                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                  TypeDescription
                                                                                                                  System.BooleanTrue if the clipboard content was set successfully.
                                                                                                                  +
                                                                                                                  +
                                                                                                                  + + +
                                                                                                                  +
                                                                                                                  + + +
                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.IListDataSource.html b/docs/api/Terminal.Gui/Terminal.Gui.IListDataSource.html new file mode 100644 index 0000000000..6b92aa812a --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.IListDataSource.html @@ -0,0 +1,347 @@ + + + + + + + + Interface IListDataSource + + + + + + + + + + + + + + + + +
                                                                                                                  +
                                                                                                                  + + + +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  +
                                                                                                                  + +
                                                                                                                  +
                                                                                                                  Search Results for
                                                                                                                  +
                                                                                                                  +

                                                                                                                  +
                                                                                                                  +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    + +
                                                                                                                    + +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    + + +

                                                                                                                    Interface IListDataSource +

                                                                                                                    +
                                                                                                                    +Implement IListDataSource to provide custom rendering for a ListView. +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Namespace: Terminal.Gui
                                                                                                                    +
                                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                                    +
                                                                                                                    Syntax
                                                                                                                    +
                                                                                                                    + 
                                                                                                                    public interface IListDataSource
                                                                                                                    +
                                                                                                                    +

                                                                                                                    Properties +

                                                                                                                    + +

                                                                                                                    Count

                                                                                                                    +
                                                                                                                    +Returns the number of elements to display +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Declaration
                                                                                                                    +
                                                                                                                    + 
                                                                                                                    int Count { get; }
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Property Value
                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                    TypeDescription
                                                                                                                    System.Int32
                                                                                                                    + +

                                                                                                                    Length

                                                                                                                    +
                                                                                                                    +Returns the maximum length of elements to display +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Declaration
                                                                                                                    +
                                                                                                                    + 
                                                                                                                    int Length { get; }
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Property Value
                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                    TypeDescription
                                                                                                                    System.Int32
                                                                                                                    +

                                                                                                                    Methods +

                                                                                                                    + +

                                                                                                                    IsMarked(Int32)

                                                                                                                    +
                                                                                                                    +Should return whether the specified item is currently marked. +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Declaration
                                                                                                                    +
                                                                                                                    + 
                                                                                                                    bool IsMarked(int item)
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Parameters
                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                    TypeNameDescription
                                                                                                                    System.Int32itemItem index.
                                                                                                                    +
                                                                                                                    Returns
                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                    TypeDescription
                                                                                                                    System.Booleantrue, if marked, false otherwise.
                                                                                                                    + +

                                                                                                                    Render(ListView, ConsoleDriver, Boolean, Int32, Int32, Int32, Int32, Int32)

                                                                                                                    +
                                                                                                                    +This method is invoked to render a specified item, the method should cover the entire provided width. +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Declaration
                                                                                                                    +
                                                                                                                    + 
                                                                                                                    void Render(ListView container, ConsoleDriver driver, bool selected, int item, int col, int line, int width, int start = 0)
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Parameters
                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                    TypeNameDescription
                                                                                                                    ListViewcontainerThe list view to render.
                                                                                                                    ConsoleDriverdriverThe console driver to render.
                                                                                                                    System.BooleanselectedDescribes whether the item being rendered is currently selected by the user.
                                                                                                                    System.Int32itemThe index of the item to render, zero for the first item and so on.
                                                                                                                    System.Int32colThe column where the rendering will start
                                                                                                                    System.Int32lineThe line where the rendering will be done.
                                                                                                                    System.Int32widthThe width that must be filled out.
                                                                                                                    System.Int32startThe index of the string to be displayed.
                                                                                                                    +
                                                                                                                    Remarks
                                                                                                                    +
                                                                                                                    +The default color will be set before this method is invoked, and will be based on whether the item is selected or not. +
                                                                                                                    + +

                                                                                                                    SetMark(Int32, Boolean)

                                                                                                                    +
                                                                                                                    +Flags the item as marked. +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Declaration
                                                                                                                    +
                                                                                                                    + 
                                                                                                                    void SetMark(int item, bool value)
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Parameters
                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                    TypeNameDescription
                                                                                                                    System.Int32itemItem index.
                                                                                                                    System.BooleanvalueIf set to true value.
                                                                                                                    + +

                                                                                                                    ToList()

                                                                                                                    +
                                                                                                                    +Return the source as IList. +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Declaration
                                                                                                                    +
                                                                                                                    + 
                                                                                                                    IList ToList()
                                                                                                                    +
                                                                                                                    +
                                                                                                                    Returns
                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                    TypeDescription
                                                                                                                    System.Collections.IList
                                                                                                                    +
                                                                                                                    +
                                                                                                                    + + +
                                                                                                                    +
                                                                                                                    + + +
                                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.IMainLoopDriver.html b/docs/api/Terminal.Gui/Terminal.Gui.IMainLoopDriver.html new file mode 100644 index 0000000000..94586e29ce --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.IMainLoopDriver.html @@ -0,0 +1,219 @@ + + + + + + + + Interface IMainLoopDriver + + + + + + + + + + + + + + + + +
                                                                                                                    +
                                                                                                                    + + + +
                                                                                                                    + +
                                                                                                                    +
                                                                                                                    +
                                                                                                                    + +
                                                                                                                    +
                                                                                                                    Search Results for
                                                                                                                    +
                                                                                                                    +

                                                                                                                    +
                                                                                                                    +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      + + +

                                                                                                                      Interface IMainLoopDriver +

                                                                                                                      +
                                                                                                                      +Public interface to create your own platform specific main loop driver. +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      Namespace: Terminal.Gui
                                                                                                                      +
                                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                                      +
                                                                                                                      Syntax
                                                                                                                      +
                                                                                                                      + 
                                                                                                                      public interface IMainLoopDriver
                                                                                                                      +
                                                                                                                      +

                                                                                                                      Methods +

                                                                                                                      + +

                                                                                                                      EventsPending(Boolean)

                                                                                                                      +
                                                                                                                      +Must report whether there are any events pending, or even block waiting for events. +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      Declaration
                                                                                                                      +
                                                                                                                      + 
                                                                                                                      bool EventsPending(bool wait)
                                                                                                                      +
                                                                                                                      +
                                                                                                                      Parameters
                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                      TypeNameDescription
                                                                                                                      System.BooleanwaitIf set to true wait until an event is available, otherwise return immediately.
                                                                                                                      +
                                                                                                                      Returns
                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                      TypeDescription
                                                                                                                      System.Booleantrue, if there were pending events, false otherwise.
                                                                                                                      + +

                                                                                                                      MainIteration()

                                                                                                                      +
                                                                                                                      +The iteration function. +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      Declaration
                                                                                                                      +
                                                                                                                      + 
                                                                                                                      void MainIteration()
                                                                                                                      +
                                                                                                                      + +

                                                                                                                      Setup(MainLoop)

                                                                                                                      +
                                                                                                                      +Initializes the main loop driver, gets the calling main loop for the initialization. +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      Declaration
                                                                                                                      +
                                                                                                                      + 
                                                                                                                      void Setup(MainLoop mainLoop)
                                                                                                                      +
                                                                                                                      +
                                                                                                                      Parameters
                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                      TypeNameDescription
                                                                                                                      MainLoopmainLoopMain loop.
                                                                                                                      + +

                                                                                                                      Wakeup()

                                                                                                                      +
                                                                                                                      +Wakes up the mainloop that might be waiting on input, must be thread safe. +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      Declaration
                                                                                                                      +
                                                                                                                      + 
                                                                                                                      void Wakeup()
                                                                                                                      +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      + + +
                                                                                                                      +
                                                                                                                      + + +
                                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ITreeView.html b/docs/api/Terminal.Gui/Terminal.Gui.ITreeView.html new file mode 100644 index 0000000000..5d0fb164dd --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ITreeView.html @@ -0,0 +1,179 @@ + + + + + + + + Interface ITreeView + + + + + + + + + + + + + + + + +
                                                                                                                      +
                                                                                                                      + + + +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      +
                                                                                                                      + +
                                                                                                                      +
                                                                                                                      Search Results for
                                                                                                                      +
                                                                                                                      +

                                                                                                                      +
                                                                                                                      +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        + +
                                                                                                                        + +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        + + +

                                                                                                                        Interface ITreeView +

                                                                                                                        +
                                                                                                                        +Interface for all non generic members of TreeView<T> + +See TreeView Deep Dive for more information. +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        Namespace: Terminal.Gui
                                                                                                                        +
                                                                                                                        Assembly: Terminal.Gui.dll
                                                                                                                        +
                                                                                                                        Syntax
                                                                                                                        +
                                                                                                                        + 
                                                                                                                        public interface ITreeView
                                                                                                                        +
                                                                                                                        +

                                                                                                                        Properties +

                                                                                                                        + +

                                                                                                                        Style

                                                                                                                        +
                                                                                                                        +Contains options for changing how the tree is rendered +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        Declaration
                                                                                                                        +
                                                                                                                        + 
                                                                                                                        TreeStyle Style { get; set; }
                                                                                                                        +
                                                                                                                        +
                                                                                                                        Property Value
                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                        TypeDescription
                                                                                                                        TreeStyle
                                                                                                                        +

                                                                                                                        Methods +

                                                                                                                        + +

                                                                                                                        ClearObjects()

                                                                                                                        +
                                                                                                                        +Removes all objects from the tree and clears selection +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        Declaration
                                                                                                                        +
                                                                                                                        + 
                                                                                                                        void ClearObjects()
                                                                                                                        +
                                                                                                                        + +

                                                                                                                        SetNeedsDisplay()

                                                                                                                        +
                                                                                                                        +Sets a flag indicating this view needs to be redisplayed because its state has changed. +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        Declaration
                                                                                                                        +
                                                                                                                        + 
                                                                                                                        void SetNeedsDisplay()
                                                                                                                        +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        + + +
                                                                                                                        +
                                                                                                                        + + +
                                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Key.html b/docs/api/Terminal.Gui/Terminal.Gui.Key.html new file mode 100644 index 0000000000..f143e051d5 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Key.html @@ -0,0 +1,751 @@ + + + + + + + + Enum Key + + + + + + + + + + + + + + + + +
                                                                                                                        +
                                                                                                                        + + + +
                                                                                                                        + +
                                                                                                                        +
                                                                                                                        +
                                                                                                                        + +
                                                                                                                        +
                                                                                                                        Search Results for
                                                                                                                        +
                                                                                                                        +

                                                                                                                        +
                                                                                                                        +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          + + +

                                                                                                                          Enum Key +

                                                                                                                          +
                                                                                                                          +The Key enumeration contains special encoding for some keys, but can also +encode all the unicode values that can be passed. +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          Namespace: Terminal.Gui
                                                                                                                          +
                                                                                                                          Assembly: Terminal.Gui.dll
                                                                                                                          +
                                                                                                                          Syntax
                                                                                                                          +
                                                                                                                          + 
                                                                                                                          [Flags]
+public enum Key : uint
                                                                                                                          +
                                                                                                                          +
                                                                                                                          Remarks
                                                                                                                          +
                                                                                                                          +

                                                                                                                          + If the SpecialMask is set, then the value is that of the special mask, + otherwise, the value is the one of the lower bits (as extracted by CharMask) +

                                                                                                                          + Numerics keys are the values between 48 and 57 corresponding to 0 to 9 +

                                                                                                                          +

                                                                                                                          +

                                                                                                                          + Upper alpha keys are the values between 65 and 90 corresponding to A to Z +

                                                                                                                          +

                                                                                                                          + Unicode runes are also stored here, the letter 'A" for example is encoded as a value 65 (not surfaced in the enum). +

                                                                                                                          +
                                                                                                                          +

                                                                                                                          Fields +

                                                                                                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                          NameDescription
                                                                                                                          a +The key code for the user pressing A +
                                                                                                                          A +The key code for the user pressing Shift-A +
                                                                                                                          AltMask +When this value is set, the Key encodes the sequence Alt-KeyValue. +And the actual value must be extracted by removing the AltMask. +
                                                                                                                          b +The key code for the user pressing B +
                                                                                                                          B +The key code for the user pressing Shift-B +
                                                                                                                          Backspace +Backspace key. +
                                                                                                                          BackTab +Shift-tab key (backwards tab key). +
                                                                                                                          c +The key code for the user pressing C +
                                                                                                                          C +The key code for the user pressing Shift-C +
                                                                                                                          CharMask +Mask that indicates that this is a character value, values outside this range +indicate special characters like Alt-key combinations or special keys on the +keyboard like function keys, arrows keys and so on. +
                                                                                                                          CtrlMask +When this value is set, the Key encodes the sequence Ctrl-KeyValue. +And the actual value must be extracted by removing the CtrlMask. +
                                                                                                                          CursorDown +Cursor down key. +
                                                                                                                          CursorLeft +Cursor left key. +
                                                                                                                          CursorRight +Cursor right key. +
                                                                                                                          CursorUp +Cursor up key +
                                                                                                                          d +The key code for the user pressing D +
                                                                                                                          D +The key code for the user pressing Shift-D +
                                                                                                                          D0 +Digit 0. +
                                                                                                                          D1 +Digit 1. +
                                                                                                                          D2 +Digit 2. +
                                                                                                                          D3 +Digit 3. +
                                                                                                                          D4 +Digit 4. +
                                                                                                                          D5 +Digit 5. +
                                                                                                                          D6 +Digit 6. +
                                                                                                                          D7 +Digit 7. +
                                                                                                                          D8 +Digit 8. +
                                                                                                                          D9 +Digit 9. +
                                                                                                                          Delete +The key code for the user pressing the delete key. +
                                                                                                                          DeleteChar +Delete character key +
                                                                                                                          e +The key code for the user pressing E +
                                                                                                                          E +The key code for the user pressing Shift-E +
                                                                                                                          End +End key +
                                                                                                                          Enter +The key code for the user pressing the return key. +
                                                                                                                          Esc +The key code for the user pressing the escape key +
                                                                                                                          f +The key code for the user pressing F +
                                                                                                                          F +The key code for the user pressing Shift-F +
                                                                                                                          F1 +F1 key. +
                                                                                                                          F10 +F10 key. +
                                                                                                                          F11 +F11 key. +
                                                                                                                          F12 +F12 key. +
                                                                                                                          F2 +F2 key. +
                                                                                                                          F3 +F3 key. +
                                                                                                                          F4 +F4 key. +
                                                                                                                          F5 +F5 key. +
                                                                                                                          F6 +F6 key. +
                                                                                                                          F7 +F7 key. +
                                                                                                                          F8 +F8 key. +
                                                                                                                          F9 +F9 key. +
                                                                                                                          g +The key code for the user pressing G +
                                                                                                                          G +The key code for the user pressing Shift-G +
                                                                                                                          h +The key code for the user pressing H +
                                                                                                                          H +The key code for the user pressing Shift-H +
                                                                                                                          Home +Home key +
                                                                                                                          i +The key code for the user pressing I +
                                                                                                                          I +The key code for the user pressing Shift-I +
                                                                                                                          InsertChar +Insert character key +
                                                                                                                          j +The key code for the user pressing J +
                                                                                                                          J +The key code for the user pressing Shift-J +
                                                                                                                          k +The key code for the user pressing K +
                                                                                                                          K +The key code for the user pressing Shift-K +
                                                                                                                          l +The key code for the user pressing L +
                                                                                                                          L +The key code for the user pressing Shift-L +
                                                                                                                          m +The key code for the user pressing M +
                                                                                                                          M +The key code for the user pressing Shift-M +
                                                                                                                          n +The key code for the user pressing N +
                                                                                                                          N +The key code for the user pressing Shift-N +
                                                                                                                          Null +The key code representing null or empty +
                                                                                                                          o +The key code for the user pressing O +
                                                                                                                          O +The key code for the user pressing Shift-O +
                                                                                                                          p +The key code for the user pressing P +
                                                                                                                          P +The key code for the user pressing Shift-P +
                                                                                                                          PageDown +Page Down key. +
                                                                                                                          PageUp +Page Up key. +
                                                                                                                          q +The key code for the user pressing Q +
                                                                                                                          Q +The key code for the user pressing Shift-Q +
                                                                                                                          r +The key code for the user pressing R +
                                                                                                                          R +The key code for the user pressing Shift-R +
                                                                                                                          s +The key code for the user pressing S +
                                                                                                                          S +The key code for the user pressing Shift-S +
                                                                                                                          ShiftMask +When this value is set, the Key encodes the sequence Shift-KeyValue. +
                                                                                                                          Space +The key code for the user pressing the space bar +
                                                                                                                          SpecialMask +If the SpecialMask is set, then the value is that of the special mask, +otherwise, the value is the one of the lower bits (as extracted by CharMask). +
                                                                                                                          t +The key code for the user pressing T +
                                                                                                                          T +The key code for the user pressing Shift-T +
                                                                                                                          Tab +The key code for the user pressing the tab key (forwards tab key). +
                                                                                                                          u +The key code for the user pressing U +
                                                                                                                          U +The key code for the user pressing Shift-U +
                                                                                                                          Unknown +A key with an unknown mapping was raised. +
                                                                                                                          v +The key code for the user pressing V +
                                                                                                                          V +The key code for the user pressing Shift-V +
                                                                                                                          w +The key code for the user pressing W +
                                                                                                                          W +The key code for the user pressing Shift-W +
                                                                                                                          x +The key code for the user pressing X +
                                                                                                                          X +The key code for the user pressing Shift-X +
                                                                                                                          y +The key code for the user pressing Y +
                                                                                                                          Y +The key code for the user pressing Shift-Y +
                                                                                                                          z +The key code for the user pressing Z +
                                                                                                                          Z +The key code for the user pressing Shift-Z +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          + + +
                                                                                                                          +
                                                                                                                          + + +
                                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.KeyEvent.html b/docs/api/Terminal.Gui/Terminal.Gui.KeyEvent.html new file mode 100644 index 0000000000..a312d3f690 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.KeyEvent.html @@ -0,0 +1,432 @@ + + + + + + + + Class KeyEvent + + + + + + + + + + + + + + + + +
                                                                                                                          +
                                                                                                                          + + + +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          Search Results for
                                                                                                                          +
                                                                                                                          +

                                                                                                                          +
                                                                                                                          +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            + +
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            + + +

                                                                                                                            Class KeyEvent +

                                                                                                                            +
                                                                                                                            +Describes a keyboard event. +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Inheritance
                                                                                                                            +
                                                                                                                            System.Object
                                                                                                                            +
                                                                                                                            KeyEvent
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Inherited Members
                                                                                                                            +
                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                            +
                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                            +
                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                            +
                                                                                                                            + System.Object.GetType() +
                                                                                                                            +
                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                            +
                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Namespace: Terminal.Gui
                                                                                                                            +
                                                                                                                            Assembly: Terminal.Gui.dll
                                                                                                                            +
                                                                                                                            Syntax
                                                                                                                            +
                                                                                                                            + 
                                                                                                                            public class KeyEvent
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Constructors +

                                                                                                                            + +

                                                                                                                            KeyEvent()

                                                                                                                            +
                                                                                                                            +Constructs a new KeyEvent +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Declaration
                                                                                                                            +
                                                                                                                            + 
                                                                                                                            public KeyEvent()
                                                                                                                            +
                                                                                                                            + +

                                                                                                                            KeyEvent(Key, KeyModifiers)

                                                                                                                            +
                                                                                                                            +Constructs a new KeyEvent from the provided Key value - can be a rune cast into a Key value +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Declaration
                                                                                                                            +
                                                                                                                            + 
                                                                                                                            public KeyEvent(Key k, KeyModifiers km)
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Parameters
                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                            TypeNameDescription
                                                                                                                            Keyk
                                                                                                                            KeyModifierskm
                                                                                                                            +

                                                                                                                            Fields +

                                                                                                                            +

                                                                                                                            Key

                                                                                                                            +
                                                                                                                            +Symb olid definition for the key. +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Declaration
                                                                                                                            +
                                                                                                                            + 
                                                                                                                            public Key Key
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Field Value
                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                            TypeDescription
                                                                                                                            Key
                                                                                                                            +

                                                                                                                            Properties +

                                                                                                                            + +

                                                                                                                            IsAlt

                                                                                                                            +
                                                                                                                            +Gets a value indicating whether the Alt key was pressed (real or synthesized) +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Declaration
                                                                                                                            +
                                                                                                                            + 
                                                                                                                            public bool IsAlt { get; }
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Property Value
                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                            TypeDescription
                                                                                                                            System.Booleantrue if is alternate; otherwise, false.
                                                                                                                            + +

                                                                                                                            IsCapslock

                                                                                                                            +
                                                                                                                            +Gets a value indicating whether the Caps lock key was pressed (real or synthesized) +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Declaration
                                                                                                                            +
                                                                                                                            + 
                                                                                                                            public bool IsCapslock { get; }
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Property Value
                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                            TypeDescription
                                                                                                                            System.Booleantrue if is alternate; otherwise, false.
                                                                                                                            + +

                                                                                                                            IsCtrl

                                                                                                                            +
                                                                                                                            +Determines whether the value is a control key (and NOT just the ctrl key) +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Declaration
                                                                                                                            +
                                                                                                                            + 
                                                                                                                            public bool IsCtrl { get; }
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Property Value
                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                            TypeDescription
                                                                                                                            System.Booleantrue if is ctrl; otherwise, false.
                                                                                                                            + +

                                                                                                                            IsNumlock

                                                                                                                            +
                                                                                                                            +Gets a value indicating whether the Num lock key was pressed (real or synthesized) +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Declaration
                                                                                                                            +
                                                                                                                            + 
                                                                                                                            public bool IsNumlock { get; }
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Property Value
                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                            TypeDescription
                                                                                                                            System.Booleantrue if is alternate; otherwise, false.
                                                                                                                            + +

                                                                                                                            IsScrolllock

                                                                                                                            +
                                                                                                                            +Gets a value indicating whether the Scroll lock key was pressed (real or synthesized) +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Declaration
                                                                                                                            +
                                                                                                                            + 
                                                                                                                            public bool IsScrolllock { get; }
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Property Value
                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                            TypeDescription
                                                                                                                            System.Booleantrue if is alternate; otherwise, false.
                                                                                                                            + +

                                                                                                                            IsShift

                                                                                                                            +
                                                                                                                            +Gets a value indicating whether the Shift key was pressed. +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Declaration
                                                                                                                            +
                                                                                                                            + 
                                                                                                                            public bool IsShift { get; }
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Property Value
                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                            TypeDescription
                                                                                                                            System.Booleantrue if is shift; otherwise, false.
                                                                                                                            + +

                                                                                                                            KeyValue

                                                                                                                            +
                                                                                                                            +The key value cast to an integer, you will typical use this for +extracting the Unicode rune value out of a key, when none of the +symbolic options are in use. +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Declaration
                                                                                                                            +
                                                                                                                            + 
                                                                                                                            public int KeyValue { get; }
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Property Value
                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                            TypeDescription
                                                                                                                            System.Int32
                                                                                                                            +

                                                                                                                            Methods +

                                                                                                                            + +

                                                                                                                            ToString()

                                                                                                                            +
                                                                                                                            +Pretty prints the KeyEvent +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Declaration
                                                                                                                            +
                                                                                                                            + 
                                                                                                                            public override string ToString()
                                                                                                                            +
                                                                                                                            +
                                                                                                                            Returns
                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                            TypeDescription
                                                                                                                            System.String
                                                                                                                            +
                                                                                                                            Overrides
                                                                                                                            +
                                                                                                                            System.Object.ToString()
                                                                                                                            +
                                                                                                                            +
                                                                                                                            + + +
                                                                                                                            +
                                                                                                                            + + +
                                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.KeyModifiers.html b/docs/api/Terminal.Gui/Terminal.Gui.KeyModifiers.html new file mode 100644 index 0000000000..abaf249e41 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.KeyModifiers.html @@ -0,0 +1,303 @@ + + + + + + + + Class KeyModifiers + + + + + + + + + + + + + + + + +
                                                                                                                            +
                                                                                                                            + + + +
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            Search Results for
                                                                                                                            +
                                                                                                                            +

                                                                                                                            +
                                                                                                                            +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              + + +

                                                                                                                              Class KeyModifiers +

                                                                                                                              +
                                                                                                                              +Identifies the state of the "shift"-keys within a event. +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Inheritance
                                                                                                                              +
                                                                                                                              System.Object
                                                                                                                              +
                                                                                                                              KeyModifiers
                                                                                                                              +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Inherited Members
                                                                                                                              +
                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                              +
                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                              +
                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                              +
                                                                                                                              + System.Object.GetType() +
                                                                                                                              +
                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                              +
                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                              +
                                                                                                                              + System.Object.ToString() +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Namespace: Terminal.Gui
                                                                                                                              +
                                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                                              +
                                                                                                                              Syntax
                                                                                                                              +
                                                                                                                              + 
                                                                                                                              public class KeyModifiers
                                                                                                                              +
                                                                                                                              +

                                                                                                                              Fields +

                                                                                                                              +

                                                                                                                              Alt

                                                                                                                              +
                                                                                                                              +Check if the Alt key was pressed or not. +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Declaration
                                                                                                                              +
                                                                                                                              + 
                                                                                                                              public bool Alt
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Field Value
                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                              TypeDescription
                                                                                                                              System.Boolean
                                                                                                                              +

                                                                                                                              Capslock

                                                                                                                              +
                                                                                                                              +Check if the Caps lock key was pressed or not. +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Declaration
                                                                                                                              +
                                                                                                                              + 
                                                                                                                              public bool Capslock
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Field Value
                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                              TypeDescription
                                                                                                                              System.Boolean
                                                                                                                              +

                                                                                                                              Ctrl

                                                                                                                              +
                                                                                                                              +Check if the Ctrl key was pressed or not. +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Declaration
                                                                                                                              +
                                                                                                                              + 
                                                                                                                              public bool Ctrl
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Field Value
                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                              TypeDescription
                                                                                                                              System.Boolean
                                                                                                                              +

                                                                                                                              Numlock

                                                                                                                              +
                                                                                                                              +Check if the Num lock key was pressed or not. +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Declaration
                                                                                                                              +
                                                                                                                              + 
                                                                                                                              public bool Numlock
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Field Value
                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                              TypeDescription
                                                                                                                              System.Boolean
                                                                                                                              +

                                                                                                                              Scrolllock

                                                                                                                              +
                                                                                                                              +Check if the Scroll lock key was pressed or not. +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Declaration
                                                                                                                              +
                                                                                                                              + 
                                                                                                                              public bool Scrolllock
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Field Value
                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                              TypeDescription
                                                                                                                              System.Boolean
                                                                                                                              +

                                                                                                                              Shift

                                                                                                                              +
                                                                                                                              +Check if the Shift key was pressed or not. +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Declaration
                                                                                                                              +
                                                                                                                              + 
                                                                                                                              public bool Shift
                                                                                                                              +
                                                                                                                              +
                                                                                                                              Field Value
                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                              TypeDescription
                                                                                                                              System.Boolean
                                                                                                                              +
                                                                                                                              +
                                                                                                                              + + +
                                                                                                                              +
                                                                                                                              + + +
                                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Label.html b/docs/api/Terminal.Gui/Terminal.Gui.Label.html new file mode 100644 index 0000000000..d1fd29a959 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Label.html @@ -0,0 +1,941 @@ + + + + + + + + Class Label + + + + + + + + + + + + + + + + +
                                                                                                                              +
                                                                                                                              + + + +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              +
                                                                                                                              + +
                                                                                                                              +
                                                                                                                              Search Results for
                                                                                                                              +
                                                                                                                              +

                                                                                                                              +
                                                                                                                              +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                + +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                + + +

                                                                                                                                Class Label +

                                                                                                                                +
                                                                                                                                +The Label View displays a string at a given position and supports multiple lines separated by newline characters. +Multi-line Labels support word wrap. +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Inheritance
                                                                                                                                +
                                                                                                                                System.Object
                                                                                                                                +
                                                                                                                                Responder
                                                                                                                                +
                                                                                                                                View
                                                                                                                                +
                                                                                                                                Label
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Implements
                                                                                                                                +
                                                                                                                                System.IDisposable
                                                                                                                                +
                                                                                                                                System.ComponentModel.ISupportInitializeNotification
                                                                                                                                +
                                                                                                                                System.ComponentModel.ISupportInitialize
                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Inherited Members
                                                                                                                                + + + + + + + + + + + + + + + + +
                                                                                                                                + View.Data +
                                                                                                                                + + + + + + +
                                                                                                                                + View.Id +
                                                                                                                                + + + + + + +
                                                                                                                                + View.X +
                                                                                                                                +
                                                                                                                                + View.Y +
                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                + View.Text +
                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                +
                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                +
                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                +
                                                                                                                                + System.Object.GetType() +
                                                                                                                                +
                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                +
                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Namespace: Terminal.Gui
                                                                                                                                +
                                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                                +
                                                                                                                                Syntax
                                                                                                                                +
                                                                                                                                + 
                                                                                                                                public class Label : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Remarks
                                                                                                                                +
                                                                                                                                +The Label view is functionality identical to View and is included for API backwards compatibility. +
                                                                                                                                +

                                                                                                                                Constructors +

                                                                                                                                + +

                                                                                                                                Label()

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Declaration
                                                                                                                                +
                                                                                                                                + 
                                                                                                                                public Label()
                                                                                                                                +
                                                                                                                                + +

                                                                                                                                Label(ustring, Boolean)

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Declaration
                                                                                                                                +
                                                                                                                                + 
                                                                                                                                public Label(ustring text, bool autosize = true)
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Parameters
                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                TypeNameDescription
                                                                                                                                NStack.ustringtext
                                                                                                                                System.Booleanautosize
                                                                                                                                + +

                                                                                                                                Label(ustring, TextDirection, Boolean)

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Declaration
                                                                                                                                +
                                                                                                                                + 
                                                                                                                                public Label(ustring text, TextDirection direction, bool autosize = true)
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Parameters
                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                TypeNameDescription
                                                                                                                                NStack.ustringtext
                                                                                                                                TextDirectiondirection
                                                                                                                                System.Booleanautosize
                                                                                                                                + +

                                                                                                                                Label(Int32, Int32, ustring, Boolean)

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Declaration
                                                                                                                                +
                                                                                                                                + 
                                                                                                                                public Label(int x, int y, ustring text, bool autosize = true)
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Parameters
                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                TypeNameDescription
                                                                                                                                System.Int32x
                                                                                                                                System.Int32y
                                                                                                                                NStack.ustringtext
                                                                                                                                System.Booleanautosize
                                                                                                                                + +

                                                                                                                                Label(Rect, ustring, Boolean)

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Declaration
                                                                                                                                +
                                                                                                                                + 
                                                                                                                                public Label(Rect rect, ustring text, bool autosize = false)
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Parameters
                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                TypeNameDescription
                                                                                                                                Rectrect
                                                                                                                                NStack.ustringtext
                                                                                                                                System.Booleanautosize
                                                                                                                                + +

                                                                                                                                Label(Rect, Boolean)

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Declaration
                                                                                                                                +
                                                                                                                                + 
                                                                                                                                public Label(Rect frame, bool autosize = false)
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Parameters
                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                TypeNameDescription
                                                                                                                                Rectframe
                                                                                                                                System.Booleanautosize
                                                                                                                                +

                                                                                                                                Methods +

                                                                                                                                + +

                                                                                                                                OnClicked()

                                                                                                                                +
                                                                                                                                +Virtual method to invoke the Clicked event. +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Declaration
                                                                                                                                +
                                                                                                                                + 
                                                                                                                                public virtual void OnClicked()
                                                                                                                                +
                                                                                                                                + +

                                                                                                                                OnEnter(View)

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Declaration
                                                                                                                                +
                                                                                                                                + 
                                                                                                                                public override bool OnEnter(View view)
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Parameters
                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                TypeNameDescription
                                                                                                                                Viewview
                                                                                                                                +
                                                                                                                                Returns
                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                TypeDescription
                                                                                                                                System.Boolean
                                                                                                                                +
                                                                                                                                Overrides
                                                                                                                                + + +

                                                                                                                                OnMouseEvent(MouseEvent)

                                                                                                                                +
                                                                                                                                +Method invoked when a mouse event is generated +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Declaration
                                                                                                                                +
                                                                                                                                + 
                                                                                                                                public override bool OnMouseEvent(MouseEvent mouseEvent)
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Parameters
                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                TypeNameDescription
                                                                                                                                MouseEventmouseEvent
                                                                                                                                +
                                                                                                                                Returns
                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                TypeDescription
                                                                                                                                System.Booleantrue, if the event was handled, false otherwise.
                                                                                                                                +
                                                                                                                                Overrides
                                                                                                                                + + +

                                                                                                                                ProcessHotKey(KeyEvent)

                                                                                                                                +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Declaration
                                                                                                                                +
                                                                                                                                + 
                                                                                                                                public override bool ProcessHotKey(KeyEvent ke)
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Parameters
                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                TypeNameDescription
                                                                                                                                KeyEventke
                                                                                                                                +
                                                                                                                                Returns
                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                TypeDescription
                                                                                                                                System.Boolean
                                                                                                                                +
                                                                                                                                Overrides
                                                                                                                                + +

                                                                                                                                Events +

                                                                                                                                +

                                                                                                                                Clicked

                                                                                                                                +
                                                                                                                                +Clicked System.Action, raised when the user clicks the primary mouse button within the Bounds of this View +or if the user presses the action key while this view is focused. (TODO: IsDefault) +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Declaration
                                                                                                                                +
                                                                                                                                + 
                                                                                                                                public event Action Clicked
                                                                                                                                +
                                                                                                                                +
                                                                                                                                Event Type
                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                TypeDescription
                                                                                                                                System.Action
                                                                                                                                +
                                                                                                                                Remarks
                                                                                                                                +
                                                                                                                                +Client code can hook up to this event, it is +raised when the button is activated either with +the mouse or the keyboard. +
                                                                                                                                +

                                                                                                                                Implements

                                                                                                                                +
                                                                                                                                + System.IDisposable +
                                                                                                                                +
                                                                                                                                + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                +
                                                                                                                                + System.ComponentModel.ISupportInitialize +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                + + +
                                                                                                                                +
                                                                                                                                + + +
                                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.LayoutStyle.html b/docs/api/Terminal.Gui/Terminal.Gui.LayoutStyle.html new file mode 100644 index 0000000000..c38931f617 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.LayoutStyle.html @@ -0,0 +1,155 @@ + + + + + + + + Enum LayoutStyle + + + + + + + + + + + + + + + + +
                                                                                                                                +
                                                                                                                                + + + +
                                                                                                                                + +
                                                                                                                                +
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                +
                                                                                                                                Search Results for
                                                                                                                                +
                                                                                                                                +

                                                                                                                                +
                                                                                                                                +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  + + +

                                                                                                                                  Enum LayoutStyle +

                                                                                                                                  +
                                                                                                                                  +Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the +value from the Frame will be used, if the value is Computed, then the Frame +will be updated from the X, Y Pos objects and the Width and Height Dim objects. +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  Namespace: Terminal.Gui
                                                                                                                                  +
                                                                                                                                  Assembly: Terminal.Gui.dll
                                                                                                                                  +
                                                                                                                                  Syntax
                                                                                                                                  +
                                                                                                                                  + 
                                                                                                                                  public enum LayoutStyle
                                                                                                                                  +
                                                                                                                                  +

                                                                                                                                  Fields +

                                                                                                                                  + + + + + + + + + + + + + + + + + +
                                                                                                                                  NameDescription
                                                                                                                                  Absolute +The position and size of the view are based on the Frame value. +
                                                                                                                                  Computed +The position and size of the view will be computed based on the +X, Y, Width and Height properties and set on the Frame. +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  + + +
                                                                                                                                  +
                                                                                                                                  + + +
                                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.LineView.html b/docs/api/Terminal.Gui/Terminal.Gui.LineView.html new file mode 100644 index 0000000000..a639c6e364 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.LineView.html @@ -0,0 +1,764 @@ + + + + + + + + Class LineView + + + + + + + + + + + + + + + + +
                                                                                                                                  +
                                                                                                                                  + + + +
                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                  + +
                                                                                                                                  +
                                                                                                                                  Search Results for
                                                                                                                                  +
                                                                                                                                  +

                                                                                                                                  +
                                                                                                                                  +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    + +
                                                                                                                                    + +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    + + +

                                                                                                                                    Class LineView +

                                                                                                                                    +
                                                                                                                                    +A straight line control either horizontal or vertical +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Inheritance
                                                                                                                                    +
                                                                                                                                    System.Object
                                                                                                                                    +
                                                                                                                                    Responder
                                                                                                                                    +
                                                                                                                                    View
                                                                                                                                    +
                                                                                                                                    LineView
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Implements
                                                                                                                                    +
                                                                                                                                    System.IDisposable
                                                                                                                                    +
                                                                                                                                    System.ComponentModel.ISupportInitializeNotification
                                                                                                                                    +
                                                                                                                                    System.ComponentModel.ISupportInitialize
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Inherited Members
                                                                                                                                    + + + + + + + + + + + + + + + + +
                                                                                                                                    + View.Data +
                                                                                                                                    + + + + + + +
                                                                                                                                    + View.Id +
                                                                                                                                    + + + + + + +
                                                                                                                                    + View.X +
                                                                                                                                    +
                                                                                                                                    + View.Y +
                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                    + View.Text +
                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                    +
                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                    +
                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                    +
                                                                                                                                    + System.Object.GetType() +
                                                                                                                                    +
                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                    +
                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Namespace: Terminal.Gui
                                                                                                                                    +
                                                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                                                    +
                                                                                                                                    Syntax
                                                                                                                                    +
                                                                                                                                    + 
                                                                                                                                    public class LineView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    Constructors +

                                                                                                                                    + +

                                                                                                                                    LineView()

                                                                                                                                    +
                                                                                                                                    +Creates a horizontal line +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Declaration
                                                                                                                                    +
                                                                                                                                    + 
                                                                                                                                    public LineView()
                                                                                                                                    +
                                                                                                                                    + +

                                                                                                                                    LineView(Orientation)

                                                                                                                                    +
                                                                                                                                    +Creates a horizontal or vertical line based on orientation +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Declaration
                                                                                                                                    +
                                                                                                                                    + 
                                                                                                                                    public LineView(Orientation orientation)
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Parameters
                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                    TypeNameDescription
                                                                                                                                    Orientationorientation
                                                                                                                                    +

                                                                                                                                    Properties +

                                                                                                                                    + +

                                                                                                                                    EndingAnchor

                                                                                                                                    +
                                                                                                                                    +The rune to display at the end of the line (right end of horizontal line or bottom end of vertical). +If not specified then LineRune is used +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Declaration
                                                                                                                                    +
                                                                                                                                    + 
                                                                                                                                    public Rune? EndingAnchor { get; set; }
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Property Value
                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                    TypeDescription
                                                                                                                                    System.Nullable<System.Rune>
                                                                                                                                    + +

                                                                                                                                    LineRune

                                                                                                                                    +
                                                                                                                                    +The symbol to use for drawing the line +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Declaration
                                                                                                                                    +
                                                                                                                                    + 
                                                                                                                                    public Rune LineRune { get; set; }
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Property Value
                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                    TypeDescription
                                                                                                                                    System.Rune
                                                                                                                                    + +

                                                                                                                                    Orientation

                                                                                                                                    +
                                                                                                                                    +The direction of the line. If you change this you will need to manually update the Width/Height +of the control to cover a relevant area based on the new direction. +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Declaration
                                                                                                                                    +
                                                                                                                                    + 
                                                                                                                                    public Orientation Orientation { get; set; }
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Property Value
                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                    TypeDescription
                                                                                                                                    Orientation
                                                                                                                                    + +

                                                                                                                                    StartingAnchor

                                                                                                                                    +
                                                                                                                                    +The rune to display at the start of the line (left end of horizontal line or top end of vertical) +If not specified then LineRune is used +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Declaration
                                                                                                                                    +
                                                                                                                                    + 
                                                                                                                                    public Rune? StartingAnchor { get; set; }
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Property Value
                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                    TypeDescription
                                                                                                                                    System.Nullable<System.Rune>
                                                                                                                                    +

                                                                                                                                    Methods +

                                                                                                                                    + +

                                                                                                                                    Redraw(Rect)

                                                                                                                                    +
                                                                                                                                    +Draws the line including any starting/ending anchors +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Declaration
                                                                                                                                    +
                                                                                                                                    + 
                                                                                                                                    public override void Redraw(Rect bounds)
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    Parameters
                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                    TypeNameDescription
                                                                                                                                    Rectbounds
                                                                                                                                    +
                                                                                                                                    Overrides
                                                                                                                                    + +

                                                                                                                                    Implements

                                                                                                                                    +
                                                                                                                                    + System.IDisposable +
                                                                                                                                    +
                                                                                                                                    + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                    +
                                                                                                                                    + System.ComponentModel.ISupportInitialize +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    + + +
                                                                                                                                    +
                                                                                                                                    + + +
                                                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ListView.html b/docs/api/Terminal.Gui/Terminal.Gui.ListView.html new file mode 100644 index 0000000000..a4d0934f8b --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ListView.html @@ -0,0 +1,1726 @@ + + + + + + + + Class ListView + + + + + + + + + + + + + + + + +
                                                                                                                                    +
                                                                                                                                    + + + +
                                                                                                                                    + +
                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                    + +
                                                                                                                                    +
                                                                                                                                    Search Results for
                                                                                                                                    +
                                                                                                                                    +

                                                                                                                                    +
                                                                                                                                    +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + + +

                                                                                                                                      Class ListView +

                                                                                                                                      +
                                                                                                                                      +ListView View renders a scrollable list of data where each item can be activated to perform an action. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Inheritance
                                                                                                                                      +
                                                                                                                                      System.Object
                                                                                                                                      +
                                                                                                                                      Responder
                                                                                                                                      +
                                                                                                                                      View
                                                                                                                                      +
                                                                                                                                      ListView
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Implements
                                                                                                                                      +
                                                                                                                                      System.IDisposable
                                                                                                                                      +
                                                                                                                                      System.ComponentModel.ISupportInitializeNotification
                                                                                                                                      +
                                                                                                                                      System.ComponentModel.ISupportInitialize
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Inherited Members
                                                                                                                                      + + + + + + + + + + + + + + + + +
                                                                                                                                      + View.Data +
                                                                                                                                      + + + + + + +
                                                                                                                                      + View.Id +
                                                                                                                                      + + + + + + +
                                                                                                                                      + View.X +
                                                                                                                                      +
                                                                                                                                      + View.Y +
                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                      + View.Text +
                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                      +
                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                      +
                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                      +
                                                                                                                                      + System.Object.GetType() +
                                                                                                                                      +
                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                      +
                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Namespace: Terminal.Gui
                                                                                                                                      +
                                                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                                                      +
                                                                                                                                      Syntax
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public class ListView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Remarks
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      + The ListView displays lists of data and allows the user to scroll through the data. + Items in the can be activated firing an event (with the ENTER key or a mouse double-click). + If the AllowsMarking property is true, elements of the list can be marked by the user. +

                                                                                                                                      +

                                                                                                                                      + By default ListView uses System.Object.ToString() to render the items of any +System.Collections.IList object (e.g. arrays, System.Collections.Generic.List<T>, +and other collections). Alternatively, an object that implements the IListDataSource +interface can be provided giving full control of what is rendered. +

                                                                                                                                      +

                                                                                                                                      +ListView can display any object that implements the System.Collections.IList interface. +System.String values are converted into NStack.ustring values before rendering, and other values are +converted into System.String by calling System.Object.ToString() and then converting to NStack.ustring . +

                                                                                                                                      +

                                                                                                                                      + To change the contents of the ListView, set the Source property (when + providing custom rendering via IListDataSource) or call SetSource(IList) + an System.Collections.IList is being used. +

                                                                                                                                      +

                                                                                                                                      + When AllowsMarking is set to true the rendering will prefix the rendered items with + [x] or [ ] and bind the SPACE key to toggle the selection. To implement a different + marking style set AllowsMarking to false and implement custom rendering. +

                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      Constructors +

                                                                                                                                      + +

                                                                                                                                      ListView()

                                                                                                                                      +
                                                                                                                                      +Initializes a new instance of ListView. Set the Source property to display something. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public ListView()
                                                                                                                                      +
                                                                                                                                      + +

                                                                                                                                      ListView(IList)

                                                                                                                                      +
                                                                                                                                      +Initializes a new instance of ListView that will display the contents of the object implementing the System.Collections.IList interface, +with relative positioning. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public ListView(IList source)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      System.Collections.IListsourceAn System.Collections.IList data source, if the elements are strings or ustrings, the string is rendered, otherwise the ToString() method is invoked on the result.
                                                                                                                                      + +

                                                                                                                                      ListView(IListDataSource)

                                                                                                                                      +
                                                                                                                                      +Initializes a new instance of ListView that will display the provided data source, using relative positioning. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public ListView(IListDataSource source)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      IListDataSourcesourceIListDataSource object that provides a mechanism to render the data. + The number of elements on the collection should not change, if you must change, set + the "Source" property to reset the internal settings of the ListView.
                                                                                                                                      + +

                                                                                                                                      ListView(Rect, IList)

                                                                                                                                      +
                                                                                                                                      +Initializes a new instance of ListView that will display the contents of the object implementing the System.Collections.IList interface with an absolute position. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public ListView(Rect rect, IList source)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      RectrectFrame for the listview.
                                                                                                                                      System.Collections.IListsourceAn IList data source, if the elements of the IList are strings or ustrings, the string is rendered, otherwise the ToString() method is invoked on the result.
                                                                                                                                      + +

                                                                                                                                      ListView(Rect, IListDataSource)

                                                                                                                                      +
                                                                                                                                      +Initializes a new instance of ListView with the provided data source and an absolute position +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public ListView(Rect rect, IListDataSource source)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      RectrectFrame for the listview.
                                                                                                                                      IListDataSourcesourceIListDataSource object that provides a mechanism to render the data. The number of elements on the collection should not change, if you must change, set the "Source" property to reset the internal settings of the ListView.
                                                                                                                                      +

                                                                                                                                      Properties +

                                                                                                                                      + +

                                                                                                                                      AllowsMarking

                                                                                                                                      +
                                                                                                                                      +Gets or sets whether this ListView allows items to be marked. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public bool AllowsMarking { get; set; }
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Property Value
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Booleantrue if allows marking elements of the list; otherwise, false. +
                                                                                                                                      +
                                                                                                                                      Remarks
                                                                                                                                      +
                                                                                                                                      +If set to true, ListView will render items marked items with "[x]", and unmarked items with "[ ]" +spaces. SPACE key will toggle marking. +
                                                                                                                                      + +

                                                                                                                                      AllowsMultipleSelection

                                                                                                                                      +
                                                                                                                                      +If set to true allows more than one item to be selected. If false only allow one item selected. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public bool AllowsMultipleSelection { get; set; }
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Property Value
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      LeftItem

                                                                                                                                      +
                                                                                                                                      +Gets or sets the left column where the item start to be displayed at on the ListView. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public int LeftItem { get; set; }
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Property Value
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Int32The left position.
                                                                                                                                      + +

                                                                                                                                      Maxlength

                                                                                                                                      +
                                                                                                                                      +Gets the widest item. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public int Maxlength { get; }
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Property Value
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Int32
                                                                                                                                      + +

                                                                                                                                      SelectedItem

                                                                                                                                      +
                                                                                                                                      +Gets or sets the index of the currently selected item. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public int SelectedItem { get; set; }
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Property Value
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Int32The selected item.
                                                                                                                                      + +

                                                                                                                                      Source

                                                                                                                                      +
                                                                                                                                      +Gets or sets the IListDataSource backing this ListView, enabling custom rendering. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public IListDataSource Source { get; set; }
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Property Value
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      IListDataSourceThe source.
                                                                                                                                      +
                                                                                                                                      Remarks
                                                                                                                                      +
                                                                                                                                      +Use SetSource(IList) to set a new System.Collections.IList source. +
                                                                                                                                      + +

                                                                                                                                      TopItem

                                                                                                                                      +
                                                                                                                                      +Gets or sets the item that is displayed at the top of the ListView. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public int TopItem { get; set; }
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Property Value
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Int32The top item.
                                                                                                                                      +

                                                                                                                                      Methods +

                                                                                                                                      + +

                                                                                                                                      AllowsAll()

                                                                                                                                      +
                                                                                                                                      +Prevents marking if it's not allowed mark and if it's not allows multiple selection. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual bool AllowsAll()
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      MarkUnmarkRow()

                                                                                                                                      +
                                                                                                                                      +Marks an unmarked row. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual bool MarkUnmarkRow()
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      MouseEvent(MouseEvent)

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public override bool MouseEvent(MouseEvent me)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      MouseEventme
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      +
                                                                                                                                      Overrides
                                                                                                                                      + + +

                                                                                                                                      MoveDown()

                                                                                                                                      +
                                                                                                                                      +Moves the selected item index to the next row. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual bool MoveDown()
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      MoveEnd()

                                                                                                                                      +
                                                                                                                                      +Moves the selected item index to the last row. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual bool MoveEnd()
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      MoveHome()

                                                                                                                                      +
                                                                                                                                      +Moves the selected item index to the first row. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual bool MoveHome()
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      MovePageDown()

                                                                                                                                      +
                                                                                                                                      +Moves the selected item index to the previous page. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual bool MovePageDown()
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      MovePageUp()

                                                                                                                                      +
                                                                                                                                      +Moves the selected item index to the next page. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual bool MovePageUp()
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      MoveUp()

                                                                                                                                      +
                                                                                                                                      +Moves the selected item index to the previous row. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual bool MoveUp()
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      OnEnter(View)

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public override bool OnEnter(View view)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      Viewview
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      +
                                                                                                                                      Overrides
                                                                                                                                      + + +

                                                                                                                                      OnLeave(View)

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public override bool OnLeave(View view)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      Viewview
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      +
                                                                                                                                      Overrides
                                                                                                                                      + + +

                                                                                                                                      OnOpenSelectedItem()

                                                                                                                                      +
                                                                                                                                      +Invokes the OnOpenSelectedItem event if it is defined. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual bool OnOpenSelectedItem()
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      OnRowRender(ListViewRowEventArgs)

                                                                                                                                      +
                                                                                                                                      +Virtual method that will invoke the RowRender. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual void OnRowRender(ListViewRowEventArgs rowEventArgs)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      ListViewRowEventArgsrowEventArgs
                                                                                                                                      + +

                                                                                                                                      OnSelectedChanged()

                                                                                                                                      +
                                                                                                                                      +Invokes the SelectedChanged event if it is defined. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual bool OnSelectedChanged()
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      PositionCursor()

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public override void PositionCursor()
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Overrides
                                                                                                                                      + + +

                                                                                                                                      ProcessKey(KeyEvent)

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public override bool ProcessKey(KeyEvent kb)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      KeyEventkb
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      +
                                                                                                                                      Overrides
                                                                                                                                      + + +

                                                                                                                                      Redraw(Rect)

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public override void Redraw(Rect bounds)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      Rectbounds
                                                                                                                                      +
                                                                                                                                      Overrides
                                                                                                                                      + + +

                                                                                                                                      ScrollDown(Int32)

                                                                                                                                      +
                                                                                                                                      +Scrolls the view down. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual bool ScrollDown(int lines)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      System.Int32linesNumber of lines to scroll down.
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      ScrollLeft(Int32)

                                                                                                                                      +
                                                                                                                                      +Scrolls the view left. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual bool ScrollLeft(int cols)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      System.Int32colsNumber of columns to scroll left.
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      ScrollRight(Int32)

                                                                                                                                      +
                                                                                                                                      +Scrolls the view right. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual bool ScrollRight(int cols)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      System.Int32colsNumber of columns to scroll right.
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      ScrollUp(Int32)

                                                                                                                                      +
                                                                                                                                      +Scrolls the view up. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public virtual bool ScrollUp(int lines)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      System.Int32linesNumber of lines to scroll up.
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Boolean
                                                                                                                                      + +

                                                                                                                                      SetSource(IList)

                                                                                                                                      +
                                                                                                                                      +Sets the source of the ListView to an System.Collections.IList. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public void SetSource(IList source)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      System.Collections.IListsource
                                                                                                                                      +
                                                                                                                                      Remarks
                                                                                                                                      +
                                                                                                                                      +Use the Source property to set a new IListDataSource source and use custome rendering. +
                                                                                                                                      + +

                                                                                                                                      SetSourceAsync(IList)

                                                                                                                                      +
                                                                                                                                      +Sets the source to an System.Collections.IList value asynchronously. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public Task SetSourceAsync(IList source)
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Parameters
                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                      TypeNameDescription
                                                                                                                                      System.Collections.IListsource
                                                                                                                                      +
                                                                                                                                      Returns
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Threading.Tasks.TaskAn item implementing the IList interface.
                                                                                                                                      +
                                                                                                                                      Remarks
                                                                                                                                      +
                                                                                                                                      +Use the Source property to set a new IListDataSource source and use custom rendering. +
                                                                                                                                      +

                                                                                                                                      Events +

                                                                                                                                      +

                                                                                                                                      OpenSelectedItem

                                                                                                                                      +
                                                                                                                                      +This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public event Action<ListViewItemEventArgs> OpenSelectedItem
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Event Type
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Action<ListViewItemEventArgs>
                                                                                                                                      +

                                                                                                                                      RowRender

                                                                                                                                      +
                                                                                                                                      +This event is invoked when this ListView is being drawn before rendering. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public event Action<ListViewRowEventArgs> RowRender
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Event Type
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Action<ListViewRowEventArgs>
                                                                                                                                      +

                                                                                                                                      SelectedItemChanged

                                                                                                                                      +
                                                                                                                                      +This event is raised when the selected item in the ListView has changed. +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Declaration
                                                                                                                                      +
                                                                                                                                      + 
                                                                                                                                      public event Action<ListViewItemEventArgs> SelectedItemChanged
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      Event Type
                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                      TypeDescription
                                                                                                                                      System.Action<ListViewItemEventArgs>
                                                                                                                                      +

                                                                                                                                      Implements

                                                                                                                                      +
                                                                                                                                      + System.IDisposable +
                                                                                                                                      +
                                                                                                                                      + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                      +
                                                                                                                                      + System.ComponentModel.ISupportInitialize +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + + +
                                                                                                                                      +
                                                                                                                                      + + +
                                                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ListViewItemEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.ListViewItemEventArgs.html new file mode 100644 index 0000000000..56b8fab4ef --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ListViewItemEventArgs.html @@ -0,0 +1,247 @@ + + + + + + + + Class ListViewItemEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                      +
                                                                                                                                      + + + +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      Search Results for
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        + +
                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        + + +

                                                                                                                                        Class ListViewItemEventArgs +

                                                                                                                                        +
                                                                                                                                        +System.EventArgs for ListView events. +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        Inheritance
                                                                                                                                        +
                                                                                                                                        System.Object
                                                                                                                                        +
                                                                                                                                        System.EventArgs
                                                                                                                                        +
                                                                                                                                        ListViewItemEventArgs
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        Inherited Members
                                                                                                                                        +
                                                                                                                                        + System.EventArgs.Empty +
                                                                                                                                        +
                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                        +
                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                        +
                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                        +
                                                                                                                                        + System.Object.GetType() +
                                                                                                                                        +
                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                        +
                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                        +
                                                                                                                                        + System.Object.ToString() +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        Namespace: Terminal.Gui
                                                                                                                                        +
                                                                                                                                        Assembly: Terminal.Gui.dll
                                                                                                                                        +
                                                                                                                                        Syntax
                                                                                                                                        +
                                                                                                                                        + 
                                                                                                                                        public class ListViewItemEventArgs : EventArgs
                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Constructors +

                                                                                                                                        + +

                                                                                                                                        ListViewItemEventArgs(Int32, Object)

                                                                                                                                        +
                                                                                                                                        +Initializes a new instance of ListViewItemEventArgs +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        Declaration
                                                                                                                                        +
                                                                                                                                        + 
                                                                                                                                        public ListViewItemEventArgs(int item, object value)
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        Parameters
                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                        TypeNameDescription
                                                                                                                                        System.Int32itemThe index of the ListView item.
                                                                                                                                        System.ObjectvalueThe ListView item
                                                                                                                                        +

                                                                                                                                        Properties +

                                                                                                                                        + +

                                                                                                                                        Item

                                                                                                                                        +
                                                                                                                                        +The index of the ListView item. +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        Declaration
                                                                                                                                        +
                                                                                                                                        + 
                                                                                                                                        public int Item { get; }
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        Property Value
                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                        TypeDescription
                                                                                                                                        System.Int32
                                                                                                                                        + +

                                                                                                                                        Value

                                                                                                                                        +
                                                                                                                                        +The ListView item. +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        Declaration
                                                                                                                                        +
                                                                                                                                        + 
                                                                                                                                        public object Value { get; }
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        Property Value
                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                        TypeDescription
                                                                                                                                        System.Object
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        + + +
                                                                                                                                        +
                                                                                                                                        + + +
                                                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ListViewRowEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.ListViewRowEventArgs.html new file mode 100644 index 0000000000..43af2cee37 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ListViewRowEventArgs.html @@ -0,0 +1,243 @@ + + + + + + + + Class ListViewRowEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                        +
                                                                                                                                        + + + +
                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        Search Results for
                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + + +

                                                                                                                                          Class ListViewRowEventArgs +

                                                                                                                                          +
                                                                                                                                          +System.EventArgs used by the RowRender event. +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Inheritance
                                                                                                                                          +
                                                                                                                                          System.Object
                                                                                                                                          +
                                                                                                                                          System.EventArgs
                                                                                                                                          +
                                                                                                                                          ListViewRowEventArgs
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Inherited Members
                                                                                                                                          +
                                                                                                                                          + System.EventArgs.Empty +
                                                                                                                                          +
                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                          +
                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                          +
                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                          +
                                                                                                                                          + System.Object.GetType() +
                                                                                                                                          +
                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                          +
                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                          +
                                                                                                                                          + System.Object.ToString() +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Namespace: Terminal.Gui
                                                                                                                                          +
                                                                                                                                          Assembly: Terminal.Gui.dll
                                                                                                                                          +
                                                                                                                                          Syntax
                                                                                                                                          +
                                                                                                                                          + 
                                                                                                                                          public class ListViewRowEventArgs : EventArgs
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          Constructors +

                                                                                                                                          + +

                                                                                                                                          ListViewRowEventArgs(Int32)

                                                                                                                                          +
                                                                                                                                          +Initializes with the current row. +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Declaration
                                                                                                                                          +
                                                                                                                                          + 
                                                                                                                                          public ListViewRowEventArgs(int row)
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Parameters
                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                          TypeNameDescription
                                                                                                                                          System.Int32row
                                                                                                                                          +

                                                                                                                                          Properties +

                                                                                                                                          + +

                                                                                                                                          Row

                                                                                                                                          +
                                                                                                                                          +The current row being rendered. +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Declaration
                                                                                                                                          +
                                                                                                                                          + 
                                                                                                                                          public int Row { get; }
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Property Value
                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                          TypeDescription
                                                                                                                                          System.Int32
                                                                                                                                          + +

                                                                                                                                          RowAttribute

                                                                                                                                          +
                                                                                                                                          +The Attribute used by current row or +null to maintain the current attribute. +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Declaration
                                                                                                                                          +
                                                                                                                                          + 
                                                                                                                                          public Attribute? RowAttribute { get; set; }
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          Property Value
                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                          TypeDescription
                                                                                                                                          System.Nullable<Attribute>
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + + +
                                                                                                                                          +
                                                                                                                                          + + +
                                                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ListWrapper.html b/docs/api/Terminal.Gui/Terminal.Gui.ListWrapper.html new file mode 100644 index 0000000000..c3eaebe35e --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ListWrapper.html @@ -0,0 +1,411 @@ + + + + + + + + Class ListWrapper + + + + + + + + + + + + + + + + +
                                                                                                                                          +
                                                                                                                                          + + + +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                          + +
                                                                                                                                          +
                                                                                                                                          Search Results for
                                                                                                                                          +
                                                                                                                                          +

                                                                                                                                          +
                                                                                                                                          +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            + +
                                                                                                                                            + +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            + + +

                                                                                                                                            Class ListWrapper +

                                                                                                                                            +
                                                                                                                                            +Implements an IListDataSource that renders arbitrary System.Collections.IList instances for ListView. +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Inheritance
                                                                                                                                            +
                                                                                                                                            System.Object
                                                                                                                                            +
                                                                                                                                            ListWrapper
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Implements
                                                                                                                                            + +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Inherited Members
                                                                                                                                            +
                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                            +
                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                            +
                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                            +
                                                                                                                                            + System.Object.GetType() +
                                                                                                                                            +
                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                            +
                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                            +
                                                                                                                                            + System.Object.ToString() +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Namespace: Terminal.Gui
                                                                                                                                            +
                                                                                                                                            Assembly: Terminal.Gui.dll
                                                                                                                                            +
                                                                                                                                            Syntax
                                                                                                                                            +
                                                                                                                                            + 
                                                                                                                                            public class ListWrapper : IListDataSource
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Remarks
                                                                                                                                            +
                                                                                                                                            Implements support for rendering marked items.
                                                                                                                                            +

                                                                                                                                            Constructors +

                                                                                                                                            + +

                                                                                                                                            ListWrapper(IList)

                                                                                                                                            +
                                                                                                                                            +Initializes a new instance of ListWrapper given an System.Collections.IList +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Declaration
                                                                                                                                            +
                                                                                                                                            + 
                                                                                                                                            public ListWrapper(IList source)
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Parameters
                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                            TypeNameDescription
                                                                                                                                            System.Collections.IListsource
                                                                                                                                            +

                                                                                                                                            Properties +

                                                                                                                                            + +

                                                                                                                                            Count

                                                                                                                                            +
                                                                                                                                            +Gets the number of items in the System.Collections.IList. +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Declaration
                                                                                                                                            +
                                                                                                                                            + 
                                                                                                                                            public int Count { get; }
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Property Value
                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                            TypeDescription
                                                                                                                                            System.Int32
                                                                                                                                            + +

                                                                                                                                            Length

                                                                                                                                            +
                                                                                                                                            +Gets the maximum item length in the System.Collections.IList. +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Declaration
                                                                                                                                            +
                                                                                                                                            + 
                                                                                                                                            public int Length { get; }
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Property Value
                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                            TypeDescription
                                                                                                                                            System.Int32
                                                                                                                                            +

                                                                                                                                            Methods +

                                                                                                                                            + +

                                                                                                                                            IsMarked(Int32)

                                                                                                                                            +
                                                                                                                                            +Returns true if the item is marked, false otherwise. +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Declaration
                                                                                                                                            +
                                                                                                                                            + 
                                                                                                                                            public bool IsMarked(int item)
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Parameters
                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                            TypeNameDescription
                                                                                                                                            System.Int32itemThe item.
                                                                                                                                            +
                                                                                                                                            Returns
                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                            TypeDescription
                                                                                                                                            System.BooleantrueIf is marked.falseotherwise.
                                                                                                                                            + +

                                                                                                                                            Render(ListView, ConsoleDriver, Boolean, Int32, Int32, Int32, Int32, Int32)

                                                                                                                                            +
                                                                                                                                            +Renders a ListView item to the appropriate type. +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Declaration
                                                                                                                                            +
                                                                                                                                            + 
                                                                                                                                            public void Render(ListView container, ConsoleDriver driver, bool marked, int item, int col, int line, int width, int start = 0)
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Parameters
                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                            TypeNameDescription
                                                                                                                                            ListViewcontainerThe ListView.
                                                                                                                                            ConsoleDriverdriverThe driver used by the caller.
                                                                                                                                            System.BooleanmarkedInforms if it's marked or not.
                                                                                                                                            System.Int32itemThe item.
                                                                                                                                            System.Int32colThe col where to move.
                                                                                                                                            System.Int32lineThe line where to move.
                                                                                                                                            System.Int32widthThe item width.
                                                                                                                                            System.Int32startThe index of the string to be displayed.
                                                                                                                                            + +

                                                                                                                                            SetMark(Int32, Boolean)

                                                                                                                                            +
                                                                                                                                            +Sets the item as marked or unmarked based on the value is true or false, respectively. +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Declaration
                                                                                                                                            +
                                                                                                                                            + 
                                                                                                                                            public void SetMark(int item, bool value)
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Parameters
                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                            TypeNameDescription
                                                                                                                                            System.Int32itemThe item
                                                                                                                                            System.BooleanvalueMarks the item.Unmarked the item.The value.
                                                                                                                                            + +

                                                                                                                                            ToList()

                                                                                                                                            +
                                                                                                                                            +Returns the source as IList. +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Declaration
                                                                                                                                            +
                                                                                                                                            + 
                                                                                                                                            public IList ToList()
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            Returns
                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                            TypeDescription
                                                                                                                                            System.Collections.IList
                                                                                                                                            +

                                                                                                                                            Implements

                                                                                                                                            + +
                                                                                                                                            +
                                                                                                                                            + + +
                                                                                                                                            +
                                                                                                                                            + + +
                                                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MainLoop.Timeout.html b/docs/api/Terminal.Gui/Terminal.Gui.MainLoop.Timeout.html new file mode 100644 index 0000000000..70b53b6406 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.MainLoop.Timeout.html @@ -0,0 +1,207 @@ + + + + + + + + Class MainLoop.Timeout + + + + + + + + + + + + + + + + +
                                                                                                                                            +
                                                                                                                                            + + + +
                                                                                                                                            + +
                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            + +
                                                                                                                                            +
                                                                                                                                            Search Results for
                                                                                                                                            +
                                                                                                                                            +

                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              + +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              + + +

                                                                                                                                              Class MainLoop.Timeout +

                                                                                                                                              +
                                                                                                                                              +Provides data for timers running manipulation. +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Inheritance
                                                                                                                                              +
                                                                                                                                              System.Object
                                                                                                                                              +
                                                                                                                                              MainLoop.Timeout
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Inherited Members
                                                                                                                                              +
                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                              +
                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                              +
                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                              +
                                                                                                                                              + System.Object.GetType() +
                                                                                                                                              +
                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                              +
                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                              +
                                                                                                                                              + System.Object.ToString() +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Namespace: Terminal.Gui
                                                                                                                                              +
                                                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                                                              +
                                                                                                                                              Syntax
                                                                                                                                              +
                                                                                                                                              + 
                                                                                                                                              public sealed class Timeout
                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              Fields +

                                                                                                                                              +

                                                                                                                                              Callback

                                                                                                                                              +
                                                                                                                                              +The function that will be invoked. +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Declaration
                                                                                                                                              +
                                                                                                                                              + 
                                                                                                                                              public Func<MainLoop, bool> Callback
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Field Value
                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                              TypeDescription
                                                                                                                                              System.Func<MainLoop, System.Boolean>
                                                                                                                                              +

                                                                                                                                              Span

                                                                                                                                              +
                                                                                                                                              +Time to wait before invoke the callback. +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Declaration
                                                                                                                                              +
                                                                                                                                              + 
                                                                                                                                              public TimeSpan Span
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              Field Value
                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                              TypeDescription
                                                                                                                                              System.TimeSpan
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              + + +
                                                                                                                                              +
                                                                                                                                              + + +
                                                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MainLoop.html b/docs/api/Terminal.Gui/Terminal.Gui.MainLoop.html new file mode 100644 index 0000000000..11f0853ea1 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.MainLoop.html @@ -0,0 +1,607 @@ + + + + + + + + Class MainLoop + + + + + + + + + + + + + + + + +
                                                                                                                                              +
                                                                                                                                              + + + +
                                                                                                                                              + +
                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                              + +
                                                                                                                                              +
                                                                                                                                              Search Results for
                                                                                                                                              +
                                                                                                                                              +

                                                                                                                                              +
                                                                                                                                              +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                + +
                                                                                                                                                + +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                + + +

                                                                                                                                                Class MainLoop +

                                                                                                                                                +
                                                                                                                                                +Simple main loop implementation that can be used to monitor +file descriptor, run timers and idle handlers. +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Inheritance
                                                                                                                                                +
                                                                                                                                                System.Object
                                                                                                                                                +
                                                                                                                                                MainLoop
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Inherited Members
                                                                                                                                                +
                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                +
                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                +
                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                +
                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                +
                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                +
                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                +
                                                                                                                                                + System.Object.ToString() +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Namespace: Terminal.Gui
                                                                                                                                                +
                                                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                                                +
                                                                                                                                                Syntax
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public class MainLoop
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Remarks
                                                                                                                                                +
                                                                                                                                                +Monitoring of file descriptors is only available on Unix, there +does not seem to be a way of supporting this on Windows. +
                                                                                                                                                +

                                                                                                                                                Constructors +

                                                                                                                                                + +

                                                                                                                                                MainLoop(IMainLoopDriver)

                                                                                                                                                +
                                                                                                                                                +Creates a new Mainloop. +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Declaration
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public MainLoop(IMainLoopDriver driver)
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Parameters
                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                TypeNameDescription
                                                                                                                                                IMainLoopDriverdriverShould match the ConsoleDriver (one of the implementations UnixMainLoop, NetMainLoop or WindowsMainLoop).
                                                                                                                                                +

                                                                                                                                                Properties +

                                                                                                                                                + +

                                                                                                                                                Driver

                                                                                                                                                +
                                                                                                                                                +The current IMainLoopDriver in use. +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Declaration
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public IMainLoopDriver Driver { get; }
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Property Value
                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                TypeDescription
                                                                                                                                                IMainLoopDriverThe driver.
                                                                                                                                                + +

                                                                                                                                                IdleHandlers

                                                                                                                                                +
                                                                                                                                                +Gets the list of all idle handlers. +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Declaration
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public List<Func<bool>> IdleHandlers { get; }
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Property Value
                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                TypeDescription
                                                                                                                                                System.Collections.Generic.List<System.Func<System.Boolean>>
                                                                                                                                                + +

                                                                                                                                                Timeouts

                                                                                                                                                +
                                                                                                                                                +Gets the list of all timeouts sorted by the System.TimeSpan time ticks./>. +A shorter limit time can be added at the end, but it will be called before an +earlier addition that has a longer limit time. +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Declaration
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public SortedList<long, MainLoop.Timeout> Timeouts { get; }
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Property Value
                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                TypeDescription
                                                                                                                                                System.Collections.Generic.SortedList<System.Int64, MainLoop.Timeout>
                                                                                                                                                +

                                                                                                                                                Methods +

                                                                                                                                                + +

                                                                                                                                                AddIdle(Func<Boolean>)

                                                                                                                                                +
                                                                                                                                                +Adds specified idle handler function to mainloop processing. The handler function will be called once per iteration of the main loop after other events have been handled. +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Declaration
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public Func<bool> AddIdle(Func<bool> idleHandler)
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Parameters
                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                TypeNameDescription
                                                                                                                                                System.Func<System.Boolean>idleHandlerToken that can be used to remove the idle handler with RemoveIdle(Func<Boolean>) .
                                                                                                                                                +
                                                                                                                                                Returns
                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                TypeDescription
                                                                                                                                                System.Func<System.Boolean>
                                                                                                                                                +
                                                                                                                                                Remarks
                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                + Remove an idle hander by calling RemoveIdle(Func<Boolean>) with the token this method returns. +

                                                                                                                                                +

                                                                                                                                                + If the idleHandler returns false it will be removed and not called subsequently. +

                                                                                                                                                +
                                                                                                                                                + +

                                                                                                                                                AddTimeout(TimeSpan, Func<MainLoop, Boolean>)

                                                                                                                                                +
                                                                                                                                                +Adds a timeout to the mainloop. +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Declaration
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public object AddTimeout(TimeSpan time, Func<MainLoop, bool> callback)
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Parameters
                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                TypeNameDescription
                                                                                                                                                System.TimeSpantime
                                                                                                                                                System.Func<MainLoop, System.Boolean>callback
                                                                                                                                                +
                                                                                                                                                Returns
                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                TypeDescription
                                                                                                                                                System.Object
                                                                                                                                                +
                                                                                                                                                Remarks
                                                                                                                                                +
                                                                                                                                                +When time specified passes, the callback will be invoked. +If the callback returns true, the timeout will be reset, repeating +the invocation. If it returns false, the timeout will stop and be removed. + +The returned value is a token that can be used to stop the timeout +by calling RemoveTimeout(Object). +
                                                                                                                                                + +

                                                                                                                                                EventsPending(Boolean)

                                                                                                                                                +
                                                                                                                                                +Determines whether there are pending events to be processed. +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Declaration
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public bool EventsPending(bool wait = false)
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Parameters
                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                TypeNameDescription
                                                                                                                                                System.Booleanwait
                                                                                                                                                +
                                                                                                                                                Returns
                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                TypeDescription
                                                                                                                                                System.Boolean
                                                                                                                                                +
                                                                                                                                                Remarks
                                                                                                                                                +
                                                                                                                                                +You can use this method if you want to probe if events are pending. +Typically used if you need to flush the input queue while still +running some of your own code in your main thread. +
                                                                                                                                                + +

                                                                                                                                                Invoke(Action)

                                                                                                                                                +
                                                                                                                                                +Runs action on the thread that is processing events +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Declaration
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public void Invoke(Action action)
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Parameters
                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                TypeNameDescription
                                                                                                                                                System.Actionactionthe action to be invoked on the main processing thread.
                                                                                                                                                + +

                                                                                                                                                MainIteration()

                                                                                                                                                +
                                                                                                                                                +Runs one iteration of timers and file watches +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Declaration
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public void MainIteration()
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Remarks
                                                                                                                                                +
                                                                                                                                                +You use this to process all pending events (timers, idle handlers and file watches). + +You can use it like this: +while (main.EvensPending ()) MainIteration (); +
                                                                                                                                                + +

                                                                                                                                                RemoveIdle(Func<Boolean>)

                                                                                                                                                +
                                                                                                                                                +Removes an idle handler added with AddIdle(Func<Boolean>) from processing. +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Declaration
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public bool RemoveIdle(Func<bool> token)
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Parameters
                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                TypeNameDescription
                                                                                                                                                System.Func<System.Boolean>tokenA token returned by AddIdle(Func<Boolean>)
                                                                                                                                                +
                                                                                                                                                Returns
                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                TypeDescription
                                                                                                                                                System.Boolean
                                                                                                                                                + +

                                                                                                                                                RemoveTimeout(Object)

                                                                                                                                                +
                                                                                                                                                +Removes a previously scheduled timeout +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Declaration
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public bool RemoveTimeout(object token)
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Parameters
                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                TypeNameDescription
                                                                                                                                                System.Objecttoken
                                                                                                                                                +
                                                                                                                                                Returns
                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                TypeDescription
                                                                                                                                                System.Boolean
                                                                                                                                                +
                                                                                                                                                Remarks
                                                                                                                                                +
                                                                                                                                                +The token parameter is the value returned by AddTimeout. +
                                                                                                                                                + +

                                                                                                                                                Run()

                                                                                                                                                +
                                                                                                                                                +Runs the mainloop. +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Declaration
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public void Run()
                                                                                                                                                +
                                                                                                                                                + +

                                                                                                                                                Stop()

                                                                                                                                                +
                                                                                                                                                +Stops the mainloop. +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Declaration
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public void Stop()
                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                Events +

                                                                                                                                                +

                                                                                                                                                TimeoutAdded

                                                                                                                                                +
                                                                                                                                                +Invoked when a new timeout is added to be used on the case +if ExitRunLoopAfterFirstIteration is true, +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Declaration
                                                                                                                                                +
                                                                                                                                                + 
                                                                                                                                                public event Action<long> TimeoutAdded
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                Event Type
                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                TypeDescription
                                                                                                                                                System.Action<System.Int64>
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                + + +
                                                                                                                                                +
                                                                                                                                                + + +
                                                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html b/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html new file mode 100644 index 0000000000..99e2da014f --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html @@ -0,0 +1,1423 @@ + + + + + + + + Class MenuBar + + + + + + + + + + + + + + + + +
                                                                                                                                                +
                                                                                                                                                + + + +
                                                                                                                                                + +
                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                + +
                                                                                                                                                +
                                                                                                                                                Search Results for
                                                                                                                                                +
                                                                                                                                                +

                                                                                                                                                +
                                                                                                                                                +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + + +

                                                                                                                                                  Class MenuBar +

                                                                                                                                                  +
                                                                                                                                                  +The MenuBar provides a menu for Terminal.Gui applications. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Inheritance
                                                                                                                                                  +
                                                                                                                                                  System.Object
                                                                                                                                                  +
                                                                                                                                                  Responder
                                                                                                                                                  +
                                                                                                                                                  View
                                                                                                                                                  +
                                                                                                                                                  MenuBar
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Implements
                                                                                                                                                  +
                                                                                                                                                  System.IDisposable
                                                                                                                                                  +
                                                                                                                                                  System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                  +
                                                                                                                                                  System.ComponentModel.ISupportInitialize
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Inherited Members
                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                  + View.Data +
                                                                                                                                                  + + + + + + +
                                                                                                                                                  + View.Id +
                                                                                                                                                  + + + + + + +
                                                                                                                                                  + View.X +
                                                                                                                                                  +
                                                                                                                                                  + View.Y +
                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                  + View.Text +
                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                  +
                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                  +
                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                  +
                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                  +
                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                  +
                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Namespace: Terminal.Gui
                                                                                                                                                  +
                                                                                                                                                  Assembly: Terminal.Gui.dll
                                                                                                                                                  +
                                                                                                                                                  Syntax
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public class MenuBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Remarks
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  +The MenuBar appears on the first row of the terminal. +

                                                                                                                                                  +

                                                                                                                                                  +The MenuBar provides global hotkeys for the application. +

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Constructors +

                                                                                                                                                  + +

                                                                                                                                                  MenuBar()

                                                                                                                                                  +
                                                                                                                                                  +Initializes a new instance of the MenuBar. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public MenuBar()
                                                                                                                                                  +
                                                                                                                                                  + +

                                                                                                                                                  MenuBar(MenuBarItem[])

                                                                                                                                                  +
                                                                                                                                                  +Initializes a new instance of the MenuBar class with the specified set of toplevel menu items. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public MenuBar(MenuBarItem[] menus)
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Parameters
                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                  TypeNameDescription
                                                                                                                                                  MenuBarItem[]menusIndividual menu items; a null item will result in a separator being drawn.
                                                                                                                                                  +

                                                                                                                                                  Properties +

                                                                                                                                                  + +

                                                                                                                                                  HotKeySpecifier

                                                                                                                                                  +
                                                                                                                                                  +The specifier character for the hotkey to all menus. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public static Rune HotKeySpecifier { get; }
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Property Value
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Rune
                                                                                                                                                  + +

                                                                                                                                                  IsMenuOpen

                                                                                                                                                  +
                                                                                                                                                  +True if the menu is open; otherwise false. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public bool IsMenuOpen { get; protected set; }
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Property Value
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Boolean
                                                                                                                                                  + +

                                                                                                                                                  LastFocused

                                                                                                                                                  +
                                                                                                                                                  +Get the lasted focused view before open the menu. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public View LastFocused { get; }
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Property Value
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  View
                                                                                                                                                  + +

                                                                                                                                                  Menus

                                                                                                                                                  +
                                                                                                                                                  +Gets or sets the array of MenuBarItems for the menu. Only set this when the MenuBar is visible. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public MenuBarItem[] Menus { get; set; }
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Property Value
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  MenuBarItem[]The menu array.
                                                                                                                                                  + +

                                                                                                                                                  ShortcutDelimiter

                                                                                                                                                  +
                                                                                                                                                  +Used for change the shortcut delimiter separator. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public static ustring ShortcutDelimiter { get; set; }
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Property Value
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  NStack.ustring
                                                                                                                                                  + +

                                                                                                                                                  UseKeysUpDownAsKeysLeftRight

                                                                                                                                                  +
                                                                                                                                                  +Used for change the navigation key style. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public bool UseKeysUpDownAsKeysLeftRight { get; set; }
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Property Value
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Boolean
                                                                                                                                                  + +

                                                                                                                                                  UseSubMenusSingleFrame

                                                                                                                                                  +
                                                                                                                                                  +Gets or sets if the sub-menus must be displayed in a single or multiple frames. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public bool UseSubMenusSingleFrame { get; set; }
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Property Value
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Boolean
                                                                                                                                                  +

                                                                                                                                                  Methods +

                                                                                                                                                  + +

                                                                                                                                                  CloseMenu(Boolean)

                                                                                                                                                  +
                                                                                                                                                  +Closes the current Menu programatically, if open and not canceled. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public bool CloseMenu(bool ignoreUseSubMenusSingleFrame = false)
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Parameters
                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                  TypeNameDescription
                                                                                                                                                  System.BooleanignoreUseSubMenusSingleFrame
                                                                                                                                                  +
                                                                                                                                                  Returns
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Boolean
                                                                                                                                                  + +

                                                                                                                                                  MouseEvent(MouseEvent)

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public override bool MouseEvent(MouseEvent me)
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Parameters
                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                  TypeNameDescription
                                                                                                                                                  MouseEventme
                                                                                                                                                  +
                                                                                                                                                  Returns
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Boolean
                                                                                                                                                  +
                                                                                                                                                  Overrides
                                                                                                                                                  + + +

                                                                                                                                                  OnEnter(View)

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public override bool OnEnter(View view)
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Parameters
                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                  TypeNameDescription
                                                                                                                                                  Viewview
                                                                                                                                                  +
                                                                                                                                                  Returns
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Boolean
                                                                                                                                                  +
                                                                                                                                                  Overrides
                                                                                                                                                  + + +

                                                                                                                                                  OnKeyDown(KeyEvent)

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public override bool OnKeyDown(KeyEvent keyEvent)
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Parameters
                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                  TypeNameDescription
                                                                                                                                                  KeyEventkeyEvent
                                                                                                                                                  +
                                                                                                                                                  Returns
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Boolean
                                                                                                                                                  +
                                                                                                                                                  Overrides
                                                                                                                                                  + + +

                                                                                                                                                  OnKeyUp(KeyEvent)

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public override bool OnKeyUp(KeyEvent keyEvent)
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Parameters
                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                  TypeNameDescription
                                                                                                                                                  KeyEventkeyEvent
                                                                                                                                                  +
                                                                                                                                                  Returns
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Boolean
                                                                                                                                                  +
                                                                                                                                                  Overrides
                                                                                                                                                  + + +

                                                                                                                                                  OnLeave(View)

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public override bool OnLeave(View view)
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Parameters
                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                  TypeNameDescription
                                                                                                                                                  Viewview
                                                                                                                                                  +
                                                                                                                                                  Returns
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Boolean
                                                                                                                                                  +
                                                                                                                                                  Overrides
                                                                                                                                                  + + +

                                                                                                                                                  OnMenuAllClosed()

                                                                                                                                                  +
                                                                                                                                                  +Virtual method that will invoke the MenuAllClosed +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public virtual void OnMenuAllClosed()
                                                                                                                                                  +
                                                                                                                                                  + +

                                                                                                                                                  OnMenuClosing(MenuBarItem, Boolean, Boolean)

                                                                                                                                                  +
                                                                                                                                                  +Virtual method that will invoke the MenuClosing +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public virtual MenuClosingEventArgs OnMenuClosing(MenuBarItem currentMenu, bool reopen, bool isSubMenu)
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Parameters
                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                  TypeNameDescription
                                                                                                                                                  MenuBarItemcurrentMenuThe current menu to be closed.
                                                                                                                                                  System.BooleanreopenWhether the current menu will be reopen.
                                                                                                                                                  System.BooleanisSubMenuWhether is a sub-menu or not.
                                                                                                                                                  +
                                                                                                                                                  Returns
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  MenuClosingEventArgs
                                                                                                                                                  + +

                                                                                                                                                  OnMenuOpened()

                                                                                                                                                  +
                                                                                                                                                  +Virtual method that will invoke the MenuOpened event if it's defined. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public virtual void OnMenuOpened()
                                                                                                                                                  +
                                                                                                                                                  + +

                                                                                                                                                  OnMenuOpening(MenuBarItem)

                                                                                                                                                  +
                                                                                                                                                  +Virtual method that will invoke the MenuOpening event if it's defined. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public virtual MenuOpeningEventArgs OnMenuOpening(MenuBarItem currentMenu)
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Parameters
                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                  TypeNameDescription
                                                                                                                                                  MenuBarItemcurrentMenuThe current menu to be replaced.
                                                                                                                                                  +
                                                                                                                                                  Returns
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  MenuOpeningEventArgsReturns the MenuOpeningEventArgs
                                                                                                                                                  + +

                                                                                                                                                  OpenMenu()

                                                                                                                                                  +
                                                                                                                                                  +Opens the current Menu programatically. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public void OpenMenu()
                                                                                                                                                  +
                                                                                                                                                  + +

                                                                                                                                                  PositionCursor()

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public override void PositionCursor()
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Overrides
                                                                                                                                                  + + +

                                                                                                                                                  ProcessColdKey(KeyEvent)

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public override bool ProcessColdKey(KeyEvent kb)
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Parameters
                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                  TypeNameDescription
                                                                                                                                                  KeyEventkb
                                                                                                                                                  +
                                                                                                                                                  Returns
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Boolean
                                                                                                                                                  +
                                                                                                                                                  Overrides
                                                                                                                                                  + + +

                                                                                                                                                  ProcessHotKey(KeyEvent)

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public override bool ProcessHotKey(KeyEvent kb)
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Parameters
                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                  TypeNameDescription
                                                                                                                                                  KeyEventkb
                                                                                                                                                  +
                                                                                                                                                  Returns
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Boolean
                                                                                                                                                  +
                                                                                                                                                  Overrides
                                                                                                                                                  + + +

                                                                                                                                                  ProcessKey(KeyEvent)

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public override bool ProcessKey(KeyEvent kb)
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Parameters
                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                  TypeNameDescription
                                                                                                                                                  KeyEventkb
                                                                                                                                                  +
                                                                                                                                                  Returns
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Boolean
                                                                                                                                                  +
                                                                                                                                                  Overrides
                                                                                                                                                  + + +

                                                                                                                                                  Redraw(Rect)

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public override void Redraw(Rect bounds)
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Parameters
                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                  TypeNameDescription
                                                                                                                                                  Rectbounds
                                                                                                                                                  +
                                                                                                                                                  Overrides
                                                                                                                                                  + +

                                                                                                                                                  Events +

                                                                                                                                                  +

                                                                                                                                                  MenuAllClosed

                                                                                                                                                  +
                                                                                                                                                  +Raised when all the menu are closed. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public event Action MenuAllClosed
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Event Type
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Action
                                                                                                                                                  +

                                                                                                                                                  MenuClosing

                                                                                                                                                  +
                                                                                                                                                  +Raised when a menu is closing passing MenuClosingEventArgs. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public event Action<MenuClosingEventArgs> MenuClosing
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Event Type
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Action<MenuClosingEventArgs>
                                                                                                                                                  +

                                                                                                                                                  MenuOpened

                                                                                                                                                  +
                                                                                                                                                  +Raised when a menu is opened. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public event Action<MenuItem> MenuOpened
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Event Type
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Action<MenuItem>
                                                                                                                                                  +

                                                                                                                                                  MenuOpening

                                                                                                                                                  +
                                                                                                                                                  +Raised as a menu is opening. +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Declaration
                                                                                                                                                  +
                                                                                                                                                  + 
                                                                                                                                                  public event Action<MenuOpeningEventArgs> MenuOpening
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  Event Type
                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                  TypeDescription
                                                                                                                                                  System.Action<MenuOpeningEventArgs>
                                                                                                                                                  +

                                                                                                                                                  Implements

                                                                                                                                                  +
                                                                                                                                                  + System.IDisposable +
                                                                                                                                                  +
                                                                                                                                                  + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                  +
                                                                                                                                                  + System.ComponentModel.ISupportInitialize +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + + +
                                                                                                                                                  +
                                                                                                                                                  + + +
                                                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MenuBarItem.html b/docs/api/Terminal.Gui/Terminal.Gui.MenuBarItem.html new file mode 100644 index 0000000000..9556305987 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.MenuBarItem.html @@ -0,0 +1,515 @@ + + + + + + + + Class MenuBarItem + + + + + + + + + + + + + + + + +
                                                                                                                                                  +
                                                                                                                                                  + + + +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  Search Results for
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + + +

                                                                                                                                                    Class MenuBarItem +

                                                                                                                                                    +
                                                                                                                                                    +A MenuBarItem contains MenuBarItems or MenuItems. +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Inheritance
                                                                                                                                                    +
                                                                                                                                                    System.Object
                                                                                                                                                    +
                                                                                                                                                    MenuItem
                                                                                                                                                    +
                                                                                                                                                    MenuBarItem
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Inherited Members
                                                                                                                                                    + + + + + + + + + + + + + + +
                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                    +
                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                    +
                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                    +
                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                    +
                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                    +
                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                    +
                                                                                                                                                    + System.Object.ToString() +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Namespace: Terminal.Gui
                                                                                                                                                    +
                                                                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                                                                    +
                                                                                                                                                    Syntax
                                                                                                                                                    +
                                                                                                                                                    + 
                                                                                                                                                    public class MenuBarItem : MenuItem
                                                                                                                                                    +
                                                                                                                                                    +

                                                                                                                                                    Constructors +

                                                                                                                                                    + +

                                                                                                                                                    MenuBarItem()

                                                                                                                                                    +
                                                                                                                                                    +Initializes a new MenuBarItem. +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Declaration
                                                                                                                                                    +
                                                                                                                                                    + 
                                                                                                                                                    public MenuBarItem()
                                                                                                                                                    +
                                                                                                                                                    + +

                                                                                                                                                    MenuBarItem(ustring, ustring, Action, Func<Boolean>, MenuItem)

                                                                                                                                                    +
                                                                                                                                                    +Initializes a new MenuBarItem as a MenuItem. +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Declaration
                                                                                                                                                    +
                                                                                                                                                    + 
                                                                                                                                                    public MenuBarItem(ustring title, ustring help, Action action, Func<bool> canExecute = null, MenuItem parent = null)
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Parameters
                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                    TypeNameDescription
                                                                                                                                                    NStack.ustringtitleTitle for the menu item.
                                                                                                                                                    NStack.ustringhelpHelp text to display.
                                                                                                                                                    System.ActionactionAction to invoke when the menu item is activated.
                                                                                                                                                    System.Func<System.Boolean>canExecuteFunction to determine if the action can currently be executed.
                                                                                                                                                    MenuItemparentThe parent MenuItem of this if exist, otherwise is null.
                                                                                                                                                    + +

                                                                                                                                                    MenuBarItem(ustring, List<MenuItem[]>, MenuItem)

                                                                                                                                                    +
                                                                                                                                                    +Initializes a new MenuBarItem with separate list of items. +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Declaration
                                                                                                                                                    +
                                                                                                                                                    + 
                                                                                                                                                    public MenuBarItem(ustring title, List<MenuItem[]> children, MenuItem parent = null)
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Parameters
                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                    TypeNameDescription
                                                                                                                                                    NStack.ustringtitleTitle for the menu item.
                                                                                                                                                    System.Collections.Generic.List<MenuItem[]>childrenThe list of items in the current menu.
                                                                                                                                                    MenuItemparentThe parent MenuItem of this if exist, otherwise is null.
                                                                                                                                                    + +

                                                                                                                                                    MenuBarItem(ustring, MenuItem[], MenuItem)

                                                                                                                                                    +
                                                                                                                                                    +Initializes a new MenuBarItem. +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Declaration
                                                                                                                                                    +
                                                                                                                                                    + 
                                                                                                                                                    public MenuBarItem(ustring title, MenuItem[] children, MenuItem parent = null)
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Parameters
                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                    TypeNameDescription
                                                                                                                                                    NStack.ustringtitleTitle for the menu item.
                                                                                                                                                    MenuItem[]childrenThe items in the current menu.
                                                                                                                                                    MenuItemparentThe parent MenuItem of this if exist, otherwise is null.
                                                                                                                                                    + +

                                                                                                                                                    MenuBarItem(MenuItem[])

                                                                                                                                                    +
                                                                                                                                                    +Initializes a new MenuBarItem. +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Declaration
                                                                                                                                                    +
                                                                                                                                                    + 
                                                                                                                                                    public MenuBarItem(MenuItem[] children)
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Parameters
                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                    TypeNameDescription
                                                                                                                                                    MenuItem[]childrenThe items in the current menu.
                                                                                                                                                    +

                                                                                                                                                    Properties +

                                                                                                                                                    + +

                                                                                                                                                    Children

                                                                                                                                                    +
                                                                                                                                                    +Gets or sets an array of MenuItem objects that are the children of this MenuBarItem +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Declaration
                                                                                                                                                    +
                                                                                                                                                    + 
                                                                                                                                                    public MenuItem[] Children { get; set; }
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Property Value
                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                    TypeDescription
                                                                                                                                                    MenuItem[]The children.
                                                                                                                                                    +

                                                                                                                                                    Methods +

                                                                                                                                                    + +

                                                                                                                                                    GetChildrenIndex(MenuItem)

                                                                                                                                                    +
                                                                                                                                                    +Get the index of the MenuItem parameter. +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Declaration
                                                                                                                                                    +
                                                                                                                                                    + 
                                                                                                                                                    public int GetChildrenIndex(MenuItem children)
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Parameters
                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                    TypeNameDescription
                                                                                                                                                    MenuItemchildren
                                                                                                                                                    +
                                                                                                                                                    Returns
                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                    TypeDescription
                                                                                                                                                    System.Int32Returns a value bigger than -1 if the MenuItem is a child of this.
                                                                                                                                                    + +

                                                                                                                                                    IsSubMenuOf(MenuItem)

                                                                                                                                                    +
                                                                                                                                                    +Check if the MenuItem parameter is a child of this. +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Declaration
                                                                                                                                                    +
                                                                                                                                                    + 
                                                                                                                                                    public bool IsSubMenuOf(MenuItem menuItem)
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Parameters
                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                    TypeNameDescription
                                                                                                                                                    MenuItemmenuItem
                                                                                                                                                    +
                                                                                                                                                    Returns
                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                    TypeDescription
                                                                                                                                                    System.BooleanReturns true if it is a child of this. false otherwise.
                                                                                                                                                    + +

                                                                                                                                                    SubMenu(MenuItem)

                                                                                                                                                    +
                                                                                                                                                    +Check if the children parameter is a MenuBarItem. +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Declaration
                                                                                                                                                    +
                                                                                                                                                    + 
                                                                                                                                                    public MenuBarItem SubMenu(MenuItem children)
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    Parameters
                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                    TypeNameDescription
                                                                                                                                                    MenuItemchildren
                                                                                                                                                    +
                                                                                                                                                    Returns
                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                    TypeDescription
                                                                                                                                                    MenuBarItemReturns a MenuBarItem or null otherwise.
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + + +
                                                                                                                                                    +
                                                                                                                                                    + + +
                                                                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MenuClosingEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.MenuClosingEventArgs.html new file mode 100644 index 0000000000..a8db825b23 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.MenuClosingEventArgs.html @@ -0,0 +1,302 @@ + + + + + + + + Class MenuClosingEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                    +
                                                                                                                                                    + + + +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                    + +
                                                                                                                                                    +
                                                                                                                                                    Search Results for
                                                                                                                                                    +
                                                                                                                                                    +

                                                                                                                                                    +
                                                                                                                                                    +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      + +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + + +

                                                                                                                                                      Class MenuClosingEventArgs +

                                                                                                                                                      +
                                                                                                                                                      +An System.EventArgs which allows passing a cancelable menu closing event. +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Inheritance
                                                                                                                                                      +
                                                                                                                                                      System.Object
                                                                                                                                                      +
                                                                                                                                                      System.EventArgs
                                                                                                                                                      +
                                                                                                                                                      MenuClosingEventArgs
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Inherited Members
                                                                                                                                                      +
                                                                                                                                                      + System.EventArgs.Empty +
                                                                                                                                                      +
                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                      +
                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                      +
                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                      +
                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                      +
                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                      +
                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                      +
                                                                                                                                                      + System.Object.ToString() +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Namespace: Terminal.Gui
                                                                                                                                                      +
                                                                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                                                                      +
                                                                                                                                                      Syntax
                                                                                                                                                      +
                                                                                                                                                      + 
                                                                                                                                                      public class MenuClosingEventArgs : EventArgs
                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      Constructors +

                                                                                                                                                      + +

                                                                                                                                                      MenuClosingEventArgs(MenuBarItem, Boolean, Boolean)

                                                                                                                                                      +
                                                                                                                                                      +Initializes a new instance of MenuClosingEventArgs +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Declaration
                                                                                                                                                      +
                                                                                                                                                      + 
                                                                                                                                                      public MenuClosingEventArgs(MenuBarItem currentMenu, bool reopen, bool isSubMenu)
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Parameters
                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                      TypeNameDescription
                                                                                                                                                      MenuBarItemcurrentMenuThe current MenuBarItem parent.
                                                                                                                                                      System.BooleanreopenWhether the current menu will be reopen.
                                                                                                                                                      System.BooleanisSubMenuIndicates whether it is a sub-menu.
                                                                                                                                                      +

                                                                                                                                                      Properties +

                                                                                                                                                      + +

                                                                                                                                                      Cancel

                                                                                                                                                      +
                                                                                                                                                      +Flag that allows you to cancel the opening of the menu. +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Declaration
                                                                                                                                                      +
                                                                                                                                                      + 
                                                                                                                                                      public bool Cancel { get; set; }
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Property Value
                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                      TypeDescription
                                                                                                                                                      System.Boolean
                                                                                                                                                      + +

                                                                                                                                                      CurrentMenu

                                                                                                                                                      +
                                                                                                                                                      +The current MenuBarItem parent. +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Declaration
                                                                                                                                                      +
                                                                                                                                                      + 
                                                                                                                                                      public MenuBarItem CurrentMenu { get; }
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Property Value
                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                      TypeDescription
                                                                                                                                                      MenuBarItem
                                                                                                                                                      + +

                                                                                                                                                      IsSubMenu

                                                                                                                                                      +
                                                                                                                                                      +Indicates whether the current menu is a sub-menu. +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Declaration
                                                                                                                                                      +
                                                                                                                                                      + 
                                                                                                                                                      public bool IsSubMenu { get; }
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Property Value
                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                      TypeDescription
                                                                                                                                                      System.Boolean
                                                                                                                                                      + +

                                                                                                                                                      Reopen

                                                                                                                                                      +
                                                                                                                                                      +Indicates whether the current menu will be reopen. +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Declaration
                                                                                                                                                      +
                                                                                                                                                      + 
                                                                                                                                                      public bool Reopen { get; }
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      Property Value
                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                      TypeDescription
                                                                                                                                                      System.Boolean
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + + +
                                                                                                                                                      +
                                                                                                                                                      + + +
                                                                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MenuItem.html b/docs/api/Terminal.Gui/Terminal.Gui.MenuItem.html new file mode 100644 index 0000000000..e5786fd81f --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.MenuItem.html @@ -0,0 +1,598 @@ + + + + + + + + Class MenuItem + + + + + + + + + + + + + + + + +
                                                                                                                                                      +
                                                                                                                                                      + + + +
                                                                                                                                                      + +
                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      +
                                                                                                                                                      Search Results for
                                                                                                                                                      +
                                                                                                                                                      +

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        + +
                                                                                                                                                        + +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        + + +

                                                                                                                                                        Class MenuItem +

                                                                                                                                                        +
                                                                                                                                                        +A MenuItem has a title, an associated help text, and an action to execute on activation. +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Inheritance
                                                                                                                                                        +
                                                                                                                                                        System.Object
                                                                                                                                                        +
                                                                                                                                                        MenuItem
                                                                                                                                                        +
                                                                                                                                                        MenuBarItem
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Inherited Members
                                                                                                                                                        +
                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                        +
                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                        +
                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                        +
                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                        +
                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                        +
                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                        +
                                                                                                                                                        + System.Object.ToString() +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Namespace: Terminal.Gui
                                                                                                                                                        +
                                                                                                                                                        Assembly: Terminal.Gui.dll
                                                                                                                                                        +
                                                                                                                                                        Syntax
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public class MenuItem
                                                                                                                                                        +
                                                                                                                                                        +

                                                                                                                                                        Constructors +

                                                                                                                                                        + +

                                                                                                                                                        MenuItem(ustring, ustring, Action, Func<Boolean>, MenuItem, Key)

                                                                                                                                                        +
                                                                                                                                                        +Initializes a new instance of MenuItem. +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public MenuItem(ustring title, ustring help, Action action, Func<bool> canExecute = null, MenuItem parent = null, Key shortcut = Key.Null)
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Parameters
                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                        TypeNameDescription
                                                                                                                                                        NStack.ustringtitleTitle for the menu item.
                                                                                                                                                        NStack.ustringhelpHelp text to display.
                                                                                                                                                        System.ActionactionAction to invoke when the menu item is activated.
                                                                                                                                                        System.Func<System.Boolean>canExecuteFunction to determine if the action can currently be executed.
                                                                                                                                                        MenuItemparentThe Parent of this menu item.
                                                                                                                                                        KeyshortcutThe Shortcut keystroke combination.
                                                                                                                                                        + +

                                                                                                                                                        MenuItem(Key)

                                                                                                                                                        +
                                                                                                                                                        +Initializes a new instance of MenuItem +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public MenuItem(Key shortcut = Key.Null)
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Parameters
                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                        TypeNameDescription
                                                                                                                                                        Keyshortcut
                                                                                                                                                        +

                                                                                                                                                        Fields +

                                                                                                                                                        +

                                                                                                                                                        HotKey

                                                                                                                                                        +
                                                                                                                                                        +The HotKey is used when the menu is active, the shortcut can be triggered when the menu is not active. +For example HotKey would be "N" when the File Menu is open (assuming there is a "_New" entry +if the Shortcut is set to "Control-N", this would be a global hotkey that would trigger as well +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public Rune HotKey
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Field Value
                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                        TypeDescription
                                                                                                                                                        System.Rune
                                                                                                                                                        +

                                                                                                                                                        Properties +

                                                                                                                                                        + +

                                                                                                                                                        Action

                                                                                                                                                        +
                                                                                                                                                        +Gets or sets the action to be invoked when the menu is triggered +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public Action Action { get; set; }
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Property Value
                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                        TypeDescription
                                                                                                                                                        System.ActionMethod to invoke.
                                                                                                                                                        + +

                                                                                                                                                        CanExecute

                                                                                                                                                        +
                                                                                                                                                        +Gets or sets the action to be invoked if the menu can be triggered +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public Func<bool> CanExecute { get; set; }
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Property Value
                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                        TypeDescription
                                                                                                                                                        System.Func<System.Boolean>Function to determine if action is ready to be executed.
                                                                                                                                                        + +

                                                                                                                                                        Checked

                                                                                                                                                        +
                                                                                                                                                        +Sets or gets whether the MenuItem shows a check indicator or not. See MenuItemCheckStyle. +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public bool Checked { get; set; }
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Property Value
                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                        TypeDescription
                                                                                                                                                        System.Boolean
                                                                                                                                                        + +

                                                                                                                                                        CheckType

                                                                                                                                                        +
                                                                                                                                                        +Sets or gets the type selection indicator the menu item will be displayed with. +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public MenuItemCheckStyle CheckType { get; set; }
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Property Value
                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                        TypeDescription
                                                                                                                                                        MenuItemCheckStyle
                                                                                                                                                        + +

                                                                                                                                                        Data

                                                                                                                                                        +
                                                                                                                                                        +Gets or sets arbitrary data for the menu item. +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public object Data { get; set; }
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Property Value
                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                        TypeDescription
                                                                                                                                                        System.Object
                                                                                                                                                        +
                                                                                                                                                        Remarks
                                                                                                                                                        +
                                                                                                                                                        This property is not used internally.
                                                                                                                                                        + +

                                                                                                                                                        Help

                                                                                                                                                        +
                                                                                                                                                        +Gets or sets the help text for the menu item. +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public ustring Help { get; set; }
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Property Value
                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                        TypeDescription
                                                                                                                                                        NStack.ustringThe help text.
                                                                                                                                                        + +

                                                                                                                                                        Parent

                                                                                                                                                        +
                                                                                                                                                        +Gets or sets the parent for this MenuItem. +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public MenuItem Parent { get; }
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Property Value
                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                        TypeDescription
                                                                                                                                                        MenuItemThe parent.
                                                                                                                                                        + +

                                                                                                                                                        Shortcut

                                                                                                                                                        +
                                                                                                                                                        +This is the global setting that can be used as a global Shortcut to invoke the action on the menu. +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public Key Shortcut { get; set; }
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Property Value
                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                        TypeDescription
                                                                                                                                                        Key
                                                                                                                                                        + +

                                                                                                                                                        ShortcutTag

                                                                                                                                                        +
                                                                                                                                                        +The keystroke combination used in the ShortcutTag as string. +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public ustring ShortcutTag { get; }
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Property Value
                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                        TypeDescription
                                                                                                                                                        NStack.ustring
                                                                                                                                                        + +

                                                                                                                                                        Title

                                                                                                                                                        +
                                                                                                                                                        +Gets or sets the title. +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public ustring Title { get; set; }
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Property Value
                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                        TypeDescription
                                                                                                                                                        NStack.ustringThe title.
                                                                                                                                                        +

                                                                                                                                                        Methods +

                                                                                                                                                        + +

                                                                                                                                                        GetMenuBarItem()

                                                                                                                                                        +
                                                                                                                                                        +Merely a debugging aid to see the interaction with main +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public bool GetMenuBarItem()
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Returns
                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                        TypeDescription
                                                                                                                                                        System.Boolean
                                                                                                                                                        + +

                                                                                                                                                        GetMenuItem()

                                                                                                                                                        +
                                                                                                                                                        +Merely a debugging aid to see the interaction with main +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public MenuItem GetMenuItem()
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Returns
                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                        TypeDescription
                                                                                                                                                        MenuItem
                                                                                                                                                        + +

                                                                                                                                                        IsEnabled()

                                                                                                                                                        +
                                                                                                                                                        +Shortcut to check if the menu item is enabled +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Declaration
                                                                                                                                                        +
                                                                                                                                                        + 
                                                                                                                                                        public bool IsEnabled()
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        Returns
                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                        TypeDescription
                                                                                                                                                        System.Boolean
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        + + +
                                                                                                                                                        +
                                                                                                                                                        + + +
                                                                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MenuItemCheckStyle.html b/docs/api/Terminal.Gui/Terminal.Gui.MenuItemCheckStyle.html new file mode 100644 index 0000000000..815a0913a2 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.MenuItemCheckStyle.html @@ -0,0 +1,159 @@ + + + + + + + + Enum MenuItemCheckStyle + + + + + + + + + + + + + + + + +
                                                                                                                                                        +
                                                                                                                                                        + + + +
                                                                                                                                                        + +
                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                        + +
                                                                                                                                                        +
                                                                                                                                                        Search Results for
                                                                                                                                                        +
                                                                                                                                                        +

                                                                                                                                                        +
                                                                                                                                                        +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          + +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + + +

                                                                                                                                                          Enum MenuItemCheckStyle +

                                                                                                                                                          +
                                                                                                                                                          +Specifies how a MenuItem shows selection state. +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          Namespace: Terminal.Gui
                                                                                                                                                          +
                                                                                                                                                          Assembly: Terminal.Gui.dll
                                                                                                                                                          +
                                                                                                                                                          Syntax
                                                                                                                                                          +
                                                                                                                                                          + 
                                                                                                                                                          [Flags]
+public enum MenuItemCheckStyle
                                                                                                                                                          +
                                                                                                                                                          +

                                                                                                                                                          Fields +

                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                          NameDescription
                                                                                                                                                          Checked +The menu item will indicate checked/un-checked state (see Checked. +
                                                                                                                                                          NoCheck +The menu item will be shown normally, with no check indicator. +
                                                                                                                                                          Radio +The menu item is part of a menu radio group (see Checked and will indicate selected state. +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + + +
                                                                                                                                                          +
                                                                                                                                                          + + +
                                                                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MenuOpeningEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.MenuOpeningEventArgs.html new file mode 100644 index 0000000000..87f846018b --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.MenuOpeningEventArgs.html @@ -0,0 +1,267 @@ + + + + + + + + Class MenuOpeningEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                          +
                                                                                                                                                          + + + +
                                                                                                                                                          + +
                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                          + +
                                                                                                                                                          +
                                                                                                                                                          Search Results for
                                                                                                                                                          +
                                                                                                                                                          +

                                                                                                                                                          +
                                                                                                                                                          +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            + +
                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            + + +

                                                                                                                                                            Class MenuOpeningEventArgs +

                                                                                                                                                            +
                                                                                                                                                            +An System.EventArgs which allows passing a cancelable menu opening event or replacing with a new MenuBarItem. +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Inheritance
                                                                                                                                                            +
                                                                                                                                                            System.Object
                                                                                                                                                            +
                                                                                                                                                            System.EventArgs
                                                                                                                                                            +
                                                                                                                                                            MenuOpeningEventArgs
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Inherited Members
                                                                                                                                                            +
                                                                                                                                                            + System.EventArgs.Empty +
                                                                                                                                                            +
                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                            +
                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                            +
                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                            +
                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                            +
                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                            +
                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                            +
                                                                                                                                                            + System.Object.ToString() +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Namespace: Terminal.Gui
                                                                                                                                                            +
                                                                                                                                                            Assembly: Terminal.Gui.dll
                                                                                                                                                            +
                                                                                                                                                            Syntax
                                                                                                                                                            +
                                                                                                                                                            + 
                                                                                                                                                            public class MenuOpeningEventArgs : EventArgs
                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            Constructors +

                                                                                                                                                            + +

                                                                                                                                                            MenuOpeningEventArgs(MenuBarItem)

                                                                                                                                                            +
                                                                                                                                                            +Initializes a new instance of MenuOpeningEventArgs +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Declaration
                                                                                                                                                            +
                                                                                                                                                            + 
                                                                                                                                                            public MenuOpeningEventArgs(MenuBarItem currentMenu)
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Parameters
                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                            TypeNameDescription
                                                                                                                                                            MenuBarItemcurrentMenuThe current MenuBarItem parent.
                                                                                                                                                            +

                                                                                                                                                            Properties +

                                                                                                                                                            + +

                                                                                                                                                            Cancel

                                                                                                                                                            +
                                                                                                                                                            +Flag that allows you to cancel the opening of the menu. +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Declaration
                                                                                                                                                            +
                                                                                                                                                            + 
                                                                                                                                                            public bool Cancel { get; set; }
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Property Value
                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                            TypeDescription
                                                                                                                                                            System.Boolean
                                                                                                                                                            + +

                                                                                                                                                            CurrentMenu

                                                                                                                                                            +
                                                                                                                                                            +The current MenuBarItem parent. +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Declaration
                                                                                                                                                            +
                                                                                                                                                            + 
                                                                                                                                                            public MenuBarItem CurrentMenu { get; }
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Property Value
                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                            TypeDescription
                                                                                                                                                            MenuBarItem
                                                                                                                                                            + +

                                                                                                                                                            NewMenuBarItem

                                                                                                                                                            +
                                                                                                                                                            +The new MenuBarItem to be replaced. +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Declaration
                                                                                                                                                            +
                                                                                                                                                            + 
                                                                                                                                                            public MenuBarItem NewMenuBarItem { get; set; }
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            Property Value
                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                            TypeDescription
                                                                                                                                                            MenuBarItem
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            + + +
                                                                                                                                                            +
                                                                                                                                                            + + +
                                                                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MessageBox.html b/docs/api/Terminal.Gui/Terminal.Gui.MessageBox.html new file mode 100644 index 0000000000..4f46ce2392 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.MessageBox.html @@ -0,0 +1,993 @@ + + + + + + + + Class MessageBox + + + + + + + + + + + + + + + + +
                                                                                                                                                            +
                                                                                                                                                            + + + +
                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            Search Results for
                                                                                                                                                            +
                                                                                                                                                            +

                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              + +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              + + +

                                                                                                                                                              Class MessageBox +

                                                                                                                                                              +
                                                                                                                                                              +MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Inheritance
                                                                                                                                                              +
                                                                                                                                                              System.Object
                                                                                                                                                              +
                                                                                                                                                              MessageBox
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Inherited Members
                                                                                                                                                              +
                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                              +
                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                              +
                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                              +
                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                              +
                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                              +
                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                              +
                                                                                                                                                              + System.Object.ToString() +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Namespace: Terminal.Gui
                                                                                                                                                              +
                                                                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                                                                              +
                                                                                                                                                              Syntax
                                                                                                                                                              +
                                                                                                                                                              + 
                                                                                                                                                              public static class MessageBox
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Examples
                                                                                                                                                              + +
                                                                                                                                                              var n = MessageBox.Query ("Quit Demo", "Are you sure you want to quit this demo?", "Yes", "No");
+if (n == 0)
+   quit = true;
+else
+   quit = false;
                                                                                                                                                              + +

                                                                                                                                                              Properties +

                                                                                                                                                              + +

                                                                                                                                                              Clicked

                                                                                                                                                              +
                                                                                                                                                              +The index of the selected button, or -1 if the user pressed ESC to close the dialog. +This is useful for web based console where by default there is no SynchronizationContext or TaskScheduler. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Declaration
                                                                                                                                                              +
                                                                                                                                                              + 
                                                                                                                                                              public static int Clicked { get; }
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Property Value
                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                              TypeDescription
                                                                                                                                                              System.Int32
                                                                                                                                                              +

                                                                                                                                                              Methods +

                                                                                                                                                              + +

                                                                                                                                                              ErrorQuery(ustring, ustring, ustring[])

                                                                                                                                                              +
                                                                                                                                                              +Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Declaration
                                                                                                                                                              +
                                                                                                                                                              + 
                                                                                                                                                              public static int ErrorQuery(ustring title, ustring message, params ustring[] buttons)
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Parameters
                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                              TypeNameDescription
                                                                                                                                                              NStack.ustringtitleTitle for the query.
                                                                                                                                                              NStack.ustringmessageMessage to display, might contain multiple lines.
                                                                                                                                                              NStack.ustring[]buttonsArray of buttons to add.
                                                                                                                                                              +
                                                                                                                                                              Returns
                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                              TypeDescription
                                                                                                                                                              System.Int32The index of the selected button, or -1 if the user pressed ESC to close the dialog.
                                                                                                                                                              +
                                                                                                                                                              Remarks
                                                                                                                                                              +
                                                                                                                                                              +The message box will be vertically and horizontally centered in the container and the size will be automatically determined +from the size of the title, message. and buttons. +
                                                                                                                                                              + +

                                                                                                                                                              ErrorQuery(ustring, ustring, Int32, ustring[])

                                                                                                                                                              +
                                                                                                                                                              +Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Declaration
                                                                                                                                                              +
                                                                                                                                                              + 
                                                                                                                                                              public static int ErrorQuery(ustring title, ustring message, int defaultButton = 0, params ustring[] buttons)
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Parameters
                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                              TypeNameDescription
                                                                                                                                                              NStack.ustringtitleTitle for the query.
                                                                                                                                                              NStack.ustringmessageMessage to display, might contain multiple lines.
                                                                                                                                                              System.Int32defaultButtonIndex of the default button.
                                                                                                                                                              NStack.ustring[]buttonsArray of buttons to add.
                                                                                                                                                              +
                                                                                                                                                              Returns
                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                              TypeDescription
                                                                                                                                                              System.Int32The index of the selected button, or -1 if the user pressed ESC to close the dialog.
                                                                                                                                                              +
                                                                                                                                                              Remarks
                                                                                                                                                              +
                                                                                                                                                              +The message box will be vertically and horizontally centered in the container and the size will be automatically determined +from the size of the title, message. and buttons. +
                                                                                                                                                              + +

                                                                                                                                                              ErrorQuery(ustring, ustring, Int32, Border, ustring[])

                                                                                                                                                              +
                                                                                                                                                              +Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Declaration
                                                                                                                                                              +
                                                                                                                                                              + 
                                                                                                                                                              public static int ErrorQuery(ustring title, ustring message, int defaultButton = 0, Border border = null, params ustring[] buttons)
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Parameters
                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                              TypeNameDescription
                                                                                                                                                              NStack.ustringtitleTitle for the query.
                                                                                                                                                              NStack.ustringmessageMessage to display, might contain multiple lines.
                                                                                                                                                              System.Int32defaultButtonIndex of the default button.
                                                                                                                                                              BorderborderThe border settings.
                                                                                                                                                              NStack.ustring[]buttonsArray of buttons to add.
                                                                                                                                                              +
                                                                                                                                                              Returns
                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                              TypeDescription
                                                                                                                                                              System.Int32The index of the selected button, or -1 if the user pressed ESC to close the dialog.
                                                                                                                                                              +
                                                                                                                                                              Remarks
                                                                                                                                                              +
                                                                                                                                                              +The message box will be vertically and horizontally centered in the container and the size will be automatically determined +from the size of the title, message. and buttons. +
                                                                                                                                                              + +

                                                                                                                                                              ErrorQuery(Int32, Int32, ustring, ustring, ustring[])

                                                                                                                                                              +
                                                                                                                                                              +Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Declaration
                                                                                                                                                              +
                                                                                                                                                              + 
                                                                                                                                                              public static int ErrorQuery(int width, int height, ustring title, ustring message, params ustring[] buttons)
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Parameters
                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                              TypeNameDescription
                                                                                                                                                              System.Int32widthWidth for the window.
                                                                                                                                                              System.Int32heightHeight for the window.
                                                                                                                                                              NStack.ustringtitleTitle for the query.
                                                                                                                                                              NStack.ustringmessageMessage to display, might contain multiple lines.
                                                                                                                                                              NStack.ustring[]buttonsArray of buttons to add.
                                                                                                                                                              +
                                                                                                                                                              Returns
                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                              TypeDescription
                                                                                                                                                              System.Int32The index of the selected button, or -1 if the user pressed ESC to close the dialog.
                                                                                                                                                              +
                                                                                                                                                              Remarks
                                                                                                                                                              +
                                                                                                                                                              +Use ErrorQuery(ustring, ustring, ustring[]) instead; it automatically sizes the MessageBox based on the contents. +
                                                                                                                                                              + +

                                                                                                                                                              ErrorQuery(Int32, Int32, ustring, ustring, Int32, ustring[])

                                                                                                                                                              +
                                                                                                                                                              +Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Declaration
                                                                                                                                                              +
                                                                                                                                                              + 
                                                                                                                                                              public static int ErrorQuery(int width, int height, ustring title, ustring message, int defaultButton = 0, params ustring[] buttons)
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Parameters
                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                              TypeNameDescription
                                                                                                                                                              System.Int32widthWidth for the window.
                                                                                                                                                              System.Int32heightHeight for the window.
                                                                                                                                                              NStack.ustringtitleTitle for the query.
                                                                                                                                                              NStack.ustringmessageMessage to display, might contain multiple lines.
                                                                                                                                                              System.Int32defaultButtonIndex of the default button.
                                                                                                                                                              NStack.ustring[]buttonsArray of buttons to add.
                                                                                                                                                              +
                                                                                                                                                              Returns
                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                              TypeDescription
                                                                                                                                                              System.Int32The index of the selected button, or -1 if the user pressed ESC to close the dialog.
                                                                                                                                                              +
                                                                                                                                                              Remarks
                                                                                                                                                              +
                                                                                                                                                              +Use ErrorQuery(ustring, ustring, ustring[]) instead; it automatically sizes the MessageBox based on the contents. +
                                                                                                                                                              + +

                                                                                                                                                              ErrorQuery(Int32, Int32, ustring, ustring, Int32, Border, ustring[])

                                                                                                                                                              +
                                                                                                                                                              +Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Declaration
                                                                                                                                                              +
                                                                                                                                                              + 
                                                                                                                                                              public static int ErrorQuery(int width, int height, ustring title, ustring message, int defaultButton = 0, Border border = null, params ustring[] buttons)
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Parameters
                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                              TypeNameDescription
                                                                                                                                                              System.Int32widthWidth for the window.
                                                                                                                                                              System.Int32heightHeight for the window.
                                                                                                                                                              NStack.ustringtitleTitle for the query.
                                                                                                                                                              NStack.ustringmessageMessage to display, might contain multiple lines.
                                                                                                                                                              System.Int32defaultButtonIndex of the default button.
                                                                                                                                                              BorderborderThe border settings.
                                                                                                                                                              NStack.ustring[]buttonsArray of buttons to add.
                                                                                                                                                              +
                                                                                                                                                              Returns
                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                              TypeDescription
                                                                                                                                                              System.Int32The index of the selected button, or -1 if the user pressed ESC to close the dialog.
                                                                                                                                                              +
                                                                                                                                                              Remarks
                                                                                                                                                              +
                                                                                                                                                              +Use ErrorQuery(ustring, ustring, ustring[]) instead; it automatically sizes the MessageBox based on the contents. +
                                                                                                                                                              + +

                                                                                                                                                              Query(ustring, ustring, ustring[])

                                                                                                                                                              +
                                                                                                                                                              +Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Declaration
                                                                                                                                                              +
                                                                                                                                                              + 
                                                                                                                                                              public static int Query(ustring title, ustring message, params ustring[] buttons)
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Parameters
                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                              TypeNameDescription
                                                                                                                                                              NStack.ustringtitleTitle for the query.
                                                                                                                                                              NStack.ustringmessageMessage to display, might contain multiple lines.
                                                                                                                                                              NStack.ustring[]buttonsArray of buttons to add.
                                                                                                                                                              +
                                                                                                                                                              Returns
                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                              TypeDescription
                                                                                                                                                              System.Int32The index of the selected button, or -1 if the user pressed ESC to close the dialog.
                                                                                                                                                              +
                                                                                                                                                              Remarks
                                                                                                                                                              +
                                                                                                                                                              +The message box will be vertically and horizontally centered in the container and the size will be automatically determined +from the size of the message and buttons. +
                                                                                                                                                              + +

                                                                                                                                                              Query(ustring, ustring, Int32, ustring[])

                                                                                                                                                              +
                                                                                                                                                              +Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Declaration
                                                                                                                                                              +
                                                                                                                                                              + 
                                                                                                                                                              public static int Query(ustring title, ustring message, int defaultButton = 0, params ustring[] buttons)
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Parameters
                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                              TypeNameDescription
                                                                                                                                                              NStack.ustringtitleTitle for the query.
                                                                                                                                                              NStack.ustringmessageMessage to display, might contain multiple lines.
                                                                                                                                                              System.Int32defaultButtonIndex of the default button.
                                                                                                                                                              NStack.ustring[]buttonsArray of buttons to add.
                                                                                                                                                              +
                                                                                                                                                              Returns
                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                              TypeDescription
                                                                                                                                                              System.Int32The index of the selected button, or -1 if the user pressed ESC to close the dialog.
                                                                                                                                                              +
                                                                                                                                                              Remarks
                                                                                                                                                              +
                                                                                                                                                              +The message box will be vertically and horizontally centered in the container and the size will be automatically determined +from the size of the message and buttons. +
                                                                                                                                                              + +

                                                                                                                                                              Query(ustring, ustring, Int32, Border, ustring[])

                                                                                                                                                              +
                                                                                                                                                              +Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Declaration
                                                                                                                                                              +
                                                                                                                                                              + 
                                                                                                                                                              public static int Query(ustring title, ustring message, int defaultButton = 0, Border border = null, params ustring[] buttons)
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Parameters
                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                              TypeNameDescription
                                                                                                                                                              NStack.ustringtitleTitle for the query.
                                                                                                                                                              NStack.ustringmessageMessage to display, might contain multiple lines.
                                                                                                                                                              System.Int32defaultButtonIndex of the default button.
                                                                                                                                                              BorderborderThe border settings.
                                                                                                                                                              NStack.ustring[]buttonsArray of buttons to add.
                                                                                                                                                              +
                                                                                                                                                              Returns
                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                              TypeDescription
                                                                                                                                                              System.Int32The index of the selected button, or -1 if the user pressed ESC to close the dialog.
                                                                                                                                                              +
                                                                                                                                                              Remarks
                                                                                                                                                              +
                                                                                                                                                              +The message box will be vertically and horizontally centered in the container and the size will be automatically determined +from the size of the message and buttons. +
                                                                                                                                                              + +

                                                                                                                                                              Query(Int32, Int32, ustring, ustring, ustring[])

                                                                                                                                                              +
                                                                                                                                                              +Presents a normal MessageBox with the specified title and message and a list of buttons to show to the user. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Declaration
                                                                                                                                                              +
                                                                                                                                                              + 
                                                                                                                                                              public static int Query(int width, int height, ustring title, ustring message, params ustring[] buttons)
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Parameters
                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                              TypeNameDescription
                                                                                                                                                              System.Int32widthWidth for the window.
                                                                                                                                                              System.Int32heightHeight for the window.
                                                                                                                                                              NStack.ustringtitleTitle for the query.
                                                                                                                                                              NStack.ustringmessageMessage to display, might contain multiple lines.
                                                                                                                                                              NStack.ustring[]buttonsArray of buttons to add.
                                                                                                                                                              +
                                                                                                                                                              Returns
                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                              TypeDescription
                                                                                                                                                              System.Int32The index of the selected button, or -1 if the user pressed ESC to close the dialog.
                                                                                                                                                              +
                                                                                                                                                              Remarks
                                                                                                                                                              +
                                                                                                                                                              +Use Query(ustring, ustring, ustring[]) instead; it automatically sizes the MessageBox based on the contents. +
                                                                                                                                                              + +

                                                                                                                                                              Query(Int32, Int32, ustring, ustring, Int32, ustring[])

                                                                                                                                                              +
                                                                                                                                                              +Presents a normal MessageBox with the specified title and message and a list of buttons to show to the user. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Declaration
                                                                                                                                                              +
                                                                                                                                                              + 
                                                                                                                                                              public static int Query(int width, int height, ustring title, ustring message, int defaultButton = 0, params ustring[] buttons)
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Parameters
                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                              TypeNameDescription
                                                                                                                                                              System.Int32widthWidth for the window.
                                                                                                                                                              System.Int32heightHeight for the window.
                                                                                                                                                              NStack.ustringtitleTitle for the query.
                                                                                                                                                              NStack.ustringmessageMessage to display, might contain multiple lines.
                                                                                                                                                              System.Int32defaultButtonIndex of the default button.
                                                                                                                                                              NStack.ustring[]buttonsArray of buttons to add.
                                                                                                                                                              +
                                                                                                                                                              Returns
                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                              TypeDescription
                                                                                                                                                              System.Int32The index of the selected button, or -1 if the user pressed ESC to close the dialog.
                                                                                                                                                              +
                                                                                                                                                              Remarks
                                                                                                                                                              +
                                                                                                                                                              +Use Query(ustring, ustring, ustring[]) instead; it automatically sizes the MessageBox based on the contents. +
                                                                                                                                                              + +

                                                                                                                                                              Query(Int32, Int32, ustring, ustring, Int32, Border, ustring[])

                                                                                                                                                              +
                                                                                                                                                              +Presents a normal MessageBox with the specified title and message and a list of buttons to show to the user. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Declaration
                                                                                                                                                              +
                                                                                                                                                              + 
                                                                                                                                                              public static int Query(int width, int height, ustring title, ustring message, int defaultButton = 0, Border border = null, params ustring[] buttons)
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              Parameters
                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                              TypeNameDescription
                                                                                                                                                              System.Int32widthWidth for the window.
                                                                                                                                                              System.Int32heightHeight for the window.
                                                                                                                                                              NStack.ustringtitleTitle for the query.
                                                                                                                                                              NStack.ustringmessageMessage to display, might contain multiple lines.
                                                                                                                                                              System.Int32defaultButtonIndex of the default button.
                                                                                                                                                              BorderborderThe border settings.
                                                                                                                                                              NStack.ustring[]buttonsArray of buttons to add.
                                                                                                                                                              +
                                                                                                                                                              Returns
                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                              TypeDescription
                                                                                                                                                              System.Int32The index of the selected button, or -1 if the user pressed ESC to close the dialog.
                                                                                                                                                              +
                                                                                                                                                              Remarks
                                                                                                                                                              +
                                                                                                                                                              +Use Query(ustring, ustring, ustring[]) instead; it automatically sizes the MessageBox based on the contents. +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              + + +
                                                                                                                                                              +
                                                                                                                                                              + + +
                                                                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MouseEvent.html b/docs/api/Terminal.Gui/Terminal.Gui.MouseEvent.html new file mode 100644 index 0000000000..e3127a799a --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.MouseEvent.html @@ -0,0 +1,321 @@ + + + + + + + + Struct MouseEvent + + + + + + + + + + + + + + + + +
                                                                                                                                                              +
                                                                                                                                                              + + + +
                                                                                                                                                              + +
                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                              + +
                                                                                                                                                              +
                                                                                                                                                              Search Results for
                                                                                                                                                              +
                                                                                                                                                              +

                                                                                                                                                              +
                                                                                                                                                              +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                + +
                                                                                                                                                                + +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                + + +

                                                                                                                                                                Struct MouseEvent +

                                                                                                                                                                +
                                                                                                                                                                +Describes a mouse event +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Inherited Members
                                                                                                                                                                +
                                                                                                                                                                + System.ValueType.Equals(System.Object) +
                                                                                                                                                                +
                                                                                                                                                                + System.ValueType.GetHashCode() +
                                                                                                                                                                +
                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                +
                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                +
                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Namespace: Terminal.Gui
                                                                                                                                                                +
                                                                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                                                                +
                                                                                                                                                                Syntax
                                                                                                                                                                +
                                                                                                                                                                + 
                                                                                                                                                                public struct MouseEvent
                                                                                                                                                                +
                                                                                                                                                                +

                                                                                                                                                                Fields +

                                                                                                                                                                +

                                                                                                                                                                Flags

                                                                                                                                                                +
                                                                                                                                                                +Flags indicating the kind of mouse event that is being posted. +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Declaration
                                                                                                                                                                +
                                                                                                                                                                + 
                                                                                                                                                                public MouseFlags Flags
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Field Value
                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                TypeDescription
                                                                                                                                                                MouseFlags
                                                                                                                                                                +

                                                                                                                                                                OfX

                                                                                                                                                                +
                                                                                                                                                                +The offset X (column) location for the mouse event. +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Declaration
                                                                                                                                                                +
                                                                                                                                                                + 
                                                                                                                                                                public int OfX
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Field Value
                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                TypeDescription
                                                                                                                                                                System.Int32
                                                                                                                                                                +

                                                                                                                                                                OfY

                                                                                                                                                                +
                                                                                                                                                                +The offset Y (column) location for the mouse event. +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Declaration
                                                                                                                                                                +
                                                                                                                                                                + 
                                                                                                                                                                public int OfY
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Field Value
                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                TypeDescription
                                                                                                                                                                System.Int32
                                                                                                                                                                +

                                                                                                                                                                View

                                                                                                                                                                +
                                                                                                                                                                +The current view at the location for the mouse event. +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Declaration
                                                                                                                                                                +
                                                                                                                                                                + 
                                                                                                                                                                public View View
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Field Value
                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                TypeDescription
                                                                                                                                                                View
                                                                                                                                                                +

                                                                                                                                                                X

                                                                                                                                                                +
                                                                                                                                                                +The X (column) location for the mouse event. +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Declaration
                                                                                                                                                                +
                                                                                                                                                                + 
                                                                                                                                                                public int X
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Field Value
                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                TypeDescription
                                                                                                                                                                System.Int32
                                                                                                                                                                +

                                                                                                                                                                Y

                                                                                                                                                                +
                                                                                                                                                                +The Y (column) location for the mouse event. +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Declaration
                                                                                                                                                                +
                                                                                                                                                                + 
                                                                                                                                                                public int Y
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Field Value
                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                TypeDescription
                                                                                                                                                                System.Int32
                                                                                                                                                                +

                                                                                                                                                                Methods +

                                                                                                                                                                + +

                                                                                                                                                                ToString()

                                                                                                                                                                +
                                                                                                                                                                +Returns a System.String that represents the current MouseEvent. +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Declaration
                                                                                                                                                                +
                                                                                                                                                                + 
                                                                                                                                                                public override string ToString()
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                Returns
                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                TypeDescription
                                                                                                                                                                System.StringA System.String that represents the current MouseEvent.
                                                                                                                                                                +
                                                                                                                                                                Overrides
                                                                                                                                                                +
                                                                                                                                                                System.ValueType.ToString()
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                + + +
                                                                                                                                                                +
                                                                                                                                                                + + +
                                                                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MouseFlags.html b/docs/api/Terminal.Gui/Terminal.Gui.MouseFlags.html new file mode 100644 index 0000000000..f6abf62cd0 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.MouseFlags.html @@ -0,0 +1,319 @@ + + + + + + + + Enum MouseFlags + + + + + + + + + + + + + + + + +
                                                                                                                                                                +
                                                                                                                                                                + + + +
                                                                                                                                                                + +
                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                + +
                                                                                                                                                                +
                                                                                                                                                                Search Results for
                                                                                                                                                                +
                                                                                                                                                                +

                                                                                                                                                                +
                                                                                                                                                                +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  + +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  + + +

                                                                                                                                                                  Enum MouseFlags +

                                                                                                                                                                  +
                                                                                                                                                                  +Mouse flags reported in MouseEvent. +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  Namespace: Terminal.Gui
                                                                                                                                                                  +
                                                                                                                                                                  Assembly: Terminal.Gui.dll
                                                                                                                                                                  +
                                                                                                                                                                  Syntax
                                                                                                                                                                  +
                                                                                                                                                                  + 
                                                                                                                                                                  [Flags]
+public enum MouseFlags
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  Remarks
                                                                                                                                                                  +
                                                                                                                                                                  +They just happen to map to the ncurses ones. +
                                                                                                                                                                  +

                                                                                                                                                                  Fields +

                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                  NameDescription
                                                                                                                                                                  AllEvents +Mask that captures all the events. +
                                                                                                                                                                  Button1Clicked +The first mouse button was clicked (press+release). +
                                                                                                                                                                  Button1DoubleClicked +The first mouse button was double-clicked. +
                                                                                                                                                                  Button1Pressed +The first mouse button was pressed. +
                                                                                                                                                                  Button1Released +The first mouse button was released. +
                                                                                                                                                                  Button1TripleClicked +The first mouse button was triple-clicked. +
                                                                                                                                                                  Button2Clicked +The second mouse button was clicked (press+release). +
                                                                                                                                                                  Button2DoubleClicked +The second mouse button was double-clicked. +
                                                                                                                                                                  Button2Pressed +The second mouse button was pressed. +
                                                                                                                                                                  Button2Released +The second mouse button was released. +
                                                                                                                                                                  Button2TripleClicked +The second mouse button was triple-clicked. +
                                                                                                                                                                  Button3Clicked +The third mouse button was clicked (press+release). +
                                                                                                                                                                  Button3DoubleClicked +The third mouse button was double-clicked. +
                                                                                                                                                                  Button3Pressed +The third mouse button was pressed. +
                                                                                                                                                                  Button3Released +The third mouse button was released. +
                                                                                                                                                                  Button3TripleClicked +The third mouse button was triple-clicked. +
                                                                                                                                                                  Button4Clicked +The fourth button was clicked (press+release). +
                                                                                                                                                                  Button4DoubleClicked +The fourth button was double-clicked. +
                                                                                                                                                                  Button4Pressed +The fourth mouse button was pressed. +
                                                                                                                                                                  Button4Released +The fourth mouse button was released. +
                                                                                                                                                                  Button4TripleClicked +The fourth button was triple-clicked. +
                                                                                                                                                                  ButtonAlt +Flag: the alt key was pressed when the mouse button took place. +
                                                                                                                                                                  ButtonCtrl +Flag: the ctrl key was pressed when the mouse button took place. +
                                                                                                                                                                  ButtonShift +Flag: the shift key was pressed when the mouse button took place. +
                                                                                                                                                                  ReportMousePosition +The mouse position is being reported in this event. +
                                                                                                                                                                  WheeledDown +Vertical button wheeled up. +
                                                                                                                                                                  WheeledLeft +Vertical button wheeled up while pressing ButtonShift. +
                                                                                                                                                                  WheeledRight +Vertical button wheeled down while pressing ButtonShift. +
                                                                                                                                                                  WheeledUp +Vertical button wheeled up. +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  + + +
                                                                                                                                                                  +
                                                                                                                                                                  + + +
                                                                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.OpenDialog.OpenMode.html b/docs/api/Terminal.Gui/Terminal.Gui.OpenDialog.OpenMode.html new file mode 100644 index 0000000000..6c44918893 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.OpenDialog.OpenMode.html @@ -0,0 +1,158 @@ + + + + + + + + Enum OpenDialog.OpenMode + + + + + + + + + + + + + + + + +
                                                                                                                                                                  +
                                                                                                                                                                  + + + +
                                                                                                                                                                  + +
                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  +
                                                                                                                                                                  Search Results for
                                                                                                                                                                  +
                                                                                                                                                                  +

                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    + +
                                                                                                                                                                    + +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    + + +

                                                                                                                                                                    Enum OpenDialog.OpenMode +

                                                                                                                                                                    +
                                                                                                                                                                    +Determine which System.IO type to open. +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    Namespace: Terminal.Gui
                                                                                                                                                                    +
                                                                                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                                                                                    +
                                                                                                                                                                    Syntax
                                                                                                                                                                    +
                                                                                                                                                                    + 
                                                                                                                                                                    public enum OpenMode
                                                                                                                                                                    +
                                                                                                                                                                    +

                                                                                                                                                                    Fields +

                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                    NameDescription
                                                                                                                                                                    Directory +Opens only directory or directories. +
                                                                                                                                                                    File +Opens only file or files. +
                                                                                                                                                                    Mixed +Opens files and directories. +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    + + +
                                                                                                                                                                    +
                                                                                                                                                                    + + +
                                                                                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.OpenDialog.html b/docs/api/Terminal.Gui/Terminal.Gui.OpenDialog.html new file mode 100644 index 0000000000..0df6f4bad3 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.OpenDialog.html @@ -0,0 +1,924 @@ + + + + + + + + Class OpenDialog + + + + + + + + + + + + + + + + +
                                                                                                                                                                    +
                                                                                                                                                                    + + + +
                                                                                                                                                                    + +
                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                    + +
                                                                                                                                                                    +
                                                                                                                                                                    Search Results for
                                                                                                                                                                    +
                                                                                                                                                                    +

                                                                                                                                                                    +
                                                                                                                                                                    +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      + +
                                                                                                                                                                      + +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      + + +

                                                                                                                                                                      Class OpenDialog +

                                                                                                                                                                      +
                                                                                                                                                                      +The OpenDialogprovides an interactive dialog box for users to select files or directories. +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Inheritance
                                                                                                                                                                      +
                                                                                                                                                                      System.Object
                                                                                                                                                                      +
                                                                                                                                                                      Responder
                                                                                                                                                                      +
                                                                                                                                                                      View
                                                                                                                                                                      +
                                                                                                                                                                      Toplevel
                                                                                                                                                                      +
                                                                                                                                                                      Window
                                                                                                                                                                      +
                                                                                                                                                                      Dialog
                                                                                                                                                                      +
                                                                                                                                                                      FileDialog
                                                                                                                                                                      +
                                                                                                                                                                      OpenDialog
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Implements
                                                                                                                                                                      +
                                                                                                                                                                      System.IDisposable
                                                                                                                                                                      +
                                                                                                                                                                      System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                      +
                                                                                                                                                                      System.ComponentModel.ISupportInitialize
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Inherited Members
                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                      + View.Data +
                                                                                                                                                                      + + + + + +
                                                                                                                                                                      + View.Id +
                                                                                                                                                                      + + + + + + +
                                                                                                                                                                      + View.X +
                                                                                                                                                                      +
                                                                                                                                                                      + View.Y +
                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                      +
                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                      +
                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                      +
                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                      +
                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                      +
                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Namespace: Terminal.Gui
                                                                                                                                                                      +
                                                                                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                                                                                      +
                                                                                                                                                                      Syntax
                                                                                                                                                                      +
                                                                                                                                                                      + 
                                                                                                                                                                      public class OpenDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Remarks
                                                                                                                                                                      +
                                                                                                                                                                      +

                                                                                                                                                                      + The open dialog can be used to select files for opening, it can be configured to allow + multiple items to be selected (based on the AllowsMultipleSelection) variable and + you can control whether this should allow files or directories to be selected. +

                                                                                                                                                                      +

                                                                                                                                                                      + To use, create an instance of OpenDialog, and pass it to +Run(Func<Exception, Boolean>). This will run the dialog modally, +and when this returns, the list of files will be available on the FilePaths property. +

                                                                                                                                                                      +

                                                                                                                                                                      +To select more than one file, users can use the spacebar, or control-t. +

                                                                                                                                                                      +
                                                                                                                                                                      +

                                                                                                                                                                      Constructors +

                                                                                                                                                                      + +

                                                                                                                                                                      OpenDialog()

                                                                                                                                                                      +
                                                                                                                                                                      +Initializes a new OpenDialog. +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Declaration
                                                                                                                                                                      +
                                                                                                                                                                      + 
                                                                                                                                                                      public OpenDialog()
                                                                                                                                                                      +
                                                                                                                                                                      + +

                                                                                                                                                                      OpenDialog(ustring, ustring, List<String>, OpenDialog.OpenMode)

                                                                                                                                                                      +
                                                                                                                                                                      +Initializes a new OpenDialog. +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Declaration
                                                                                                                                                                      +
                                                                                                                                                                      + 
                                                                                                                                                                      public OpenDialog(ustring title, ustring message, List<string> allowedTypes = null, OpenDialog.OpenMode openMode = OpenDialog.OpenMode.File)
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Parameters
                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                      NStack.ustringtitleThe title.
                                                                                                                                                                      NStack.ustringmessageThe message.
                                                                                                                                                                      System.Collections.Generic.List<System.String>allowedTypesThe allowed types.
                                                                                                                                                                      OpenDialog.OpenModeopenModeThe open mode.
                                                                                                                                                                      +

                                                                                                                                                                      Properties +

                                                                                                                                                                      + +

                                                                                                                                                                      AllowsMultipleSelection

                                                                                                                                                                      +
                                                                                                                                                                      +Gets or sets a value indicating whether this OpenDialog allows multiple selection. +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Declaration
                                                                                                                                                                      +
                                                                                                                                                                      + 
                                                                                                                                                                      public bool AllowsMultipleSelection { get; set; }
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Property Value
                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                      TypeDescription
                                                                                                                                                                      System.Booleantrue if allows multiple selection; otherwise, false, defaults to false.
                                                                                                                                                                      + +

                                                                                                                                                                      CanChooseDirectories

                                                                                                                                                                      +
                                                                                                                                                                      +Gets or sets a value indicating whether this OpenDialog can choose directories. +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Declaration
                                                                                                                                                                      +
                                                                                                                                                                      + 
                                                                                                                                                                      public bool CanChooseDirectories { get; set; }
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Property Value
                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                      TypeDescription
                                                                                                                                                                      System.Booleantrue if can choose directories; otherwise, false defaults to false.
                                                                                                                                                                      + +

                                                                                                                                                                      CanChooseFiles

                                                                                                                                                                      +
                                                                                                                                                                      +Gets or sets a value indicating whether this OpenDialog can choose files. +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Declaration
                                                                                                                                                                      +
                                                                                                                                                                      + 
                                                                                                                                                                      public bool CanChooseFiles { get; set; }
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Property Value
                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                      TypeDescription
                                                                                                                                                                      System.Booleantrue if can choose files; otherwise, false. Defaults to true
                                                                                                                                                                      + +

                                                                                                                                                                      FilePaths

                                                                                                                                                                      +
                                                                                                                                                                      +Returns the selected files, or an empty list if nothing has been selected +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Declaration
                                                                                                                                                                      +
                                                                                                                                                                      + 
                                                                                                                                                                      public IReadOnlyList<string> FilePaths { get; }
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      Property Value
                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                      TypeDescription
                                                                                                                                                                      System.Collections.Generic.IReadOnlyList<System.String>The file paths.
                                                                                                                                                                      +

                                                                                                                                                                      Implements

                                                                                                                                                                      +
                                                                                                                                                                      + System.IDisposable +
                                                                                                                                                                      +
                                                                                                                                                                      + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                      +
                                                                                                                                                                      + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      + + +
                                                                                                                                                                      +
                                                                                                                                                                      + + +
                                                                                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.PanelView.html b/docs/api/Terminal.Gui/Terminal.Gui.PanelView.html new file mode 100644 index 0000000000..428ae24338 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.PanelView.html @@ -0,0 +1,788 @@ + + + + + + + + Class PanelView + + + + + + + + + + + + + + + + +
                                                                                                                                                                      +
                                                                                                                                                                      + + + +
                                                                                                                                                                      + +
                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                      + +
                                                                                                                                                                      +
                                                                                                                                                                      Search Results for
                                                                                                                                                                      +
                                                                                                                                                                      +

                                                                                                                                                                      +
                                                                                                                                                                      +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        + +
                                                                                                                                                                        + +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        + + +

                                                                                                                                                                        Class PanelView +

                                                                                                                                                                        +
                                                                                                                                                                        +A container for single Child that will allow to drawn Border in +two ways. If UsePanelFrame the borders and the child will be accommodated in the available +panel size, otherwise the panel will be resized based on the child and borders thickness sizes. +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Inheritance
                                                                                                                                                                        +
                                                                                                                                                                        System.Object
                                                                                                                                                                        +
                                                                                                                                                                        Responder
                                                                                                                                                                        +
                                                                                                                                                                        View
                                                                                                                                                                        +
                                                                                                                                                                        PanelView
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Implements
                                                                                                                                                                        +
                                                                                                                                                                        System.IDisposable
                                                                                                                                                                        +
                                                                                                                                                                        System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                        +
                                                                                                                                                                        System.ComponentModel.ISupportInitialize
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Inherited Members
                                                                                                                                                                        + + + + + + + + + + + + + + + + +
                                                                                                                                                                        + View.Data +
                                                                                                                                                                        + + + + + + +
                                                                                                                                                                        + View.Id +
                                                                                                                                                                        + + + + + + +
                                                                                                                                                                        + View.X +
                                                                                                                                                                        +
                                                                                                                                                                        + View.Y +
                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                        + View.Text +
                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                        +
                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                        +
                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                        +
                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                        +
                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                        +
                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Namespace: Terminal.Gui
                                                                                                                                                                        +
                                                                                                                                                                        Assembly: Terminal.Gui.dll
                                                                                                                                                                        +
                                                                                                                                                                        Syntax
                                                                                                                                                                        +
                                                                                                                                                                        + 
                                                                                                                                                                        public class PanelView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                        +
                                                                                                                                                                        +

                                                                                                                                                                        Constructors +

                                                                                                                                                                        + +

                                                                                                                                                                        PanelView()

                                                                                                                                                                        +
                                                                                                                                                                        +Initializes a panel with a null child. +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Declaration
                                                                                                                                                                        +
                                                                                                                                                                        + 
                                                                                                                                                                        public PanelView()
                                                                                                                                                                        +
                                                                                                                                                                        + +

                                                                                                                                                                        PanelView(View)

                                                                                                                                                                        +
                                                                                                                                                                        +Initializes a panel with a valid child. +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Declaration
                                                                                                                                                                        +
                                                                                                                                                                        + 
                                                                                                                                                                        public PanelView(View child)
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Parameters
                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                        Viewchild
                                                                                                                                                                        +

                                                                                                                                                                        Properties +

                                                                                                                                                                        + +

                                                                                                                                                                        Border

                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Declaration
                                                                                                                                                                        +
                                                                                                                                                                        + 
                                                                                                                                                                        public override Border Border { get; set; }
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Property Value
                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                        TypeDescription
                                                                                                                                                                        Border
                                                                                                                                                                        +
                                                                                                                                                                        Overrides
                                                                                                                                                                        + + +

                                                                                                                                                                        Child

                                                                                                                                                                        +
                                                                                                                                                                        +The child that will use this panel. +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Declaration
                                                                                                                                                                        +
                                                                                                                                                                        + 
                                                                                                                                                                        public View Child { get; set; }
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Property Value
                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                        TypeDescription
                                                                                                                                                                        View
                                                                                                                                                                        + +

                                                                                                                                                                        UsePanelFrame

                                                                                                                                                                        +
                                                                                                                                                                        +Gets or sets if the panel size will used, otherwise the child size. +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Declaration
                                                                                                                                                                        +
                                                                                                                                                                        + 
                                                                                                                                                                        public bool UsePanelFrame { get; set; }
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Property Value
                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                        TypeDescription
                                                                                                                                                                        System.Boolean
                                                                                                                                                                        +

                                                                                                                                                                        Methods +

                                                                                                                                                                        + +

                                                                                                                                                                        Add(View)

                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Declaration
                                                                                                                                                                        +
                                                                                                                                                                        + 
                                                                                                                                                                        public override void Add(View view)
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Parameters
                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                        Viewview
                                                                                                                                                                        +
                                                                                                                                                                        Overrides
                                                                                                                                                                        + + +

                                                                                                                                                                        Redraw(Rect)

                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Declaration
                                                                                                                                                                        +
                                                                                                                                                                        + 
                                                                                                                                                                        public override void Redraw(Rect bounds)
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Parameters
                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                        Rectbounds
                                                                                                                                                                        +
                                                                                                                                                                        Overrides
                                                                                                                                                                        + + +

                                                                                                                                                                        Remove(View)

                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Declaration
                                                                                                                                                                        +
                                                                                                                                                                        + 
                                                                                                                                                                        public override void Remove(View view)
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Parameters
                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                        Viewview
                                                                                                                                                                        +
                                                                                                                                                                        Overrides
                                                                                                                                                                        + + +

                                                                                                                                                                        RemoveAll()

                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Declaration
                                                                                                                                                                        +
                                                                                                                                                                        + 
                                                                                                                                                                        public override void RemoveAll()
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        Overrides
                                                                                                                                                                        + +

                                                                                                                                                                        Implements

                                                                                                                                                                        +
                                                                                                                                                                        + System.IDisposable +
                                                                                                                                                                        +
                                                                                                                                                                        + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                        +
                                                                                                                                                                        + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        + + +
                                                                                                                                                                        +
                                                                                                                                                                        + + +
                                                                                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Point.html b/docs/api/Terminal.Gui/Terminal.Gui.Point.html new file mode 100644 index 0000000000..93678f0f82 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Point.html @@ -0,0 +1,846 @@ + + + + + + + + Struct Point + + + + + + + + + + + + + + + + +
                                                                                                                                                                        +
                                                                                                                                                                        + + + +
                                                                                                                                                                        + +
                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        + +
                                                                                                                                                                        +
                                                                                                                                                                        Search Results for
                                                                                                                                                                        +
                                                                                                                                                                        +

                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          + +
                                                                                                                                                                          + +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          + + +

                                                                                                                                                                          Struct Point +

                                                                                                                                                                          +
                                                                                                                                                                          +Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane. +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Inherited Members
                                                                                                                                                                          +
                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                          +
                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                          +
                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Namespace: Terminal.Gui
                                                                                                                                                                          +
                                                                                                                                                                          Assembly: Terminal.Gui.dll
                                                                                                                                                                          +
                                                                                                                                                                          Syntax
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public struct Point
                                                                                                                                                                          +
                                                                                                                                                                          +

                                                                                                                                                                          Constructors +

                                                                                                                                                                          + +

                                                                                                                                                                          Point(Int32, Int32)

                                                                                                                                                                          +
                                                                                                                                                                          +Point Constructor +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public Point(int x, int y)
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Parameters
                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                          System.Int32x
                                                                                                                                                                          System.Int32y
                                                                                                                                                                          +
                                                                                                                                                                          Remarks
                                                                                                                                                                          +
                                                                                                                                                                          +Creates a Point from a specified x,y coordinate pair. +
                                                                                                                                                                          + +

                                                                                                                                                                          Point(Size)

                                                                                                                                                                          +
                                                                                                                                                                          +Point Constructor +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public Point(Size sz)
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Parameters
                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                          Sizesz
                                                                                                                                                                          +
                                                                                                                                                                          Remarks
                                                                                                                                                                          +
                                                                                                                                                                          +Creates a Point from a Size value. +
                                                                                                                                                                          +

                                                                                                                                                                          Fields +

                                                                                                                                                                          +

                                                                                                                                                                          Empty

                                                                                                                                                                          +
                                                                                                                                                                          +Empty Shared Field +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public static readonly Point Empty
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Field Value
                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                          TypeDescription
                                                                                                                                                                          Point
                                                                                                                                                                          +
                                                                                                                                                                          Remarks
                                                                                                                                                                          +
                                                                                                                                                                          +An uninitialized Point Structure. +
                                                                                                                                                                          +

                                                                                                                                                                          X

                                                                                                                                                                          +
                                                                                                                                                                          +Gets or sets the x-coordinate of this Point. +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public int X
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Field Value
                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                          TypeDescription
                                                                                                                                                                          System.Int32
                                                                                                                                                                          +

                                                                                                                                                                          Y

                                                                                                                                                                          +
                                                                                                                                                                          +Gets or sets the y-coordinate of this Point. +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public int Y
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Field Value
                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                          TypeDescription
                                                                                                                                                                          System.Int32
                                                                                                                                                                          +

                                                                                                                                                                          Properties +

                                                                                                                                                                          + +

                                                                                                                                                                          IsEmpty

                                                                                                                                                                          +
                                                                                                                                                                          +IsEmpty Property +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public readonly bool IsEmpty { get; }
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Property Value
                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                          TypeDescription
                                                                                                                                                                          System.Boolean
                                                                                                                                                                          +
                                                                                                                                                                          Remarks
                                                                                                                                                                          +
                                                                                                                                                                          +Indicates if both X and Y are zero. +
                                                                                                                                                                          +

                                                                                                                                                                          Methods +

                                                                                                                                                                          + +

                                                                                                                                                                          Add(Point, Size)

                                                                                                                                                                          +
                                                                                                                                                                          +Adds the specified Size to the specified Point. +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public static Point Add(Point pt, Size sz)
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Parameters
                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                          PointptThe Point to add.
                                                                                                                                                                          SizeszThe Size to add.
                                                                                                                                                                          +
                                                                                                                                                                          Returns
                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                          TypeDescription
                                                                                                                                                                          PointThe Point that is the result of the addition operation.
                                                                                                                                                                          + +

                                                                                                                                                                          Equals(Object)

                                                                                                                                                                          +
                                                                                                                                                                          +Equals Method +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public override bool Equals(object obj)
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Parameters
                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                          System.Objectobj
                                                                                                                                                                          +
                                                                                                                                                                          Returns
                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                          TypeDescription
                                                                                                                                                                          System.Boolean
                                                                                                                                                                          +
                                                                                                                                                                          Overrides
                                                                                                                                                                          +
                                                                                                                                                                          System.ValueType.Equals(System.Object)
                                                                                                                                                                          +
                                                                                                                                                                          Remarks
                                                                                                                                                                          +
                                                                                                                                                                          +Checks equivalence of this Point and another object. +
                                                                                                                                                                          + +

                                                                                                                                                                          GetHashCode()

                                                                                                                                                                          +
                                                                                                                                                                          +GetHashCode Method +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public override int GetHashCode()
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Returns
                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                          TypeDescription
                                                                                                                                                                          System.Int32
                                                                                                                                                                          +
                                                                                                                                                                          Overrides
                                                                                                                                                                          +
                                                                                                                                                                          System.ValueType.GetHashCode()
                                                                                                                                                                          +
                                                                                                                                                                          Remarks
                                                                                                                                                                          +
                                                                                                                                                                          +Calculates a hashing value. +
                                                                                                                                                                          + +

                                                                                                                                                                          Offset(Int32, Int32)

                                                                                                                                                                          +
                                                                                                                                                                          +Offset Method +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public void Offset(int dx, int dy)
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Parameters
                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                          System.Int32dx
                                                                                                                                                                          System.Int32dy
                                                                                                                                                                          +
                                                                                                                                                                          Remarks
                                                                                                                                                                          +
                                                                                                                                                                          +Moves the Point a specified distance. +
                                                                                                                                                                          + +

                                                                                                                                                                          Offset(Point)

                                                                                                                                                                          +
                                                                                                                                                                          +Translates this Point by the specified Point. +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public void Offset(Point p)
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Parameters
                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                          PointpThe Point used offset this Point.
                                                                                                                                                                          + +

                                                                                                                                                                          Subtract(Point, Size)

                                                                                                                                                                          +
                                                                                                                                                                          +Returns the result of subtracting specified Size from the specified Point. +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public static Point Subtract(Point pt, Size sz)
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Parameters
                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                          PointptThe Point to be subtracted from.
                                                                                                                                                                          SizeszThe Size to subtract from the Point.
                                                                                                                                                                          +
                                                                                                                                                                          Returns
                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                          TypeDescription
                                                                                                                                                                          PointThe Point that is the result of the subtraction operation.
                                                                                                                                                                          + +

                                                                                                                                                                          ToString()

                                                                                                                                                                          +
                                                                                                                                                                          +ToString Method +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public override string ToString()
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Returns
                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                          TypeDescription
                                                                                                                                                                          System.String
                                                                                                                                                                          +
                                                                                                                                                                          Overrides
                                                                                                                                                                          +
                                                                                                                                                                          System.ValueType.ToString()
                                                                                                                                                                          +
                                                                                                                                                                          Remarks
                                                                                                                                                                          +
                                                                                                                                                                          +Formats the Point as a string in coordinate notation. +
                                                                                                                                                                          +

                                                                                                                                                                          Operators +

                                                                                                                                                                          + +

                                                                                                                                                                          Addition(Point, Size)

                                                                                                                                                                          +
                                                                                                                                                                          +Addition Operator +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public static Point operator +(Point pt, Size sz)
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Parameters
                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                          Pointpt
                                                                                                                                                                          Sizesz
                                                                                                                                                                          +
                                                                                                                                                                          Returns
                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                          TypeDescription
                                                                                                                                                                          Point
                                                                                                                                                                          +
                                                                                                                                                                          Remarks
                                                                                                                                                                          +
                                                                                                                                                                          +Translates a Point using the Width and Height +properties of the given Size. +
                                                                                                                                                                          + +

                                                                                                                                                                          Equality(Point, Point)

                                                                                                                                                                          +
                                                                                                                                                                          +Equality Operator +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public static bool operator ==(Point left, Point right)
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Parameters
                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                          Pointleft
                                                                                                                                                                          Pointright
                                                                                                                                                                          +
                                                                                                                                                                          Returns
                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                          TypeDescription
                                                                                                                                                                          System.Boolean
                                                                                                                                                                          +
                                                                                                                                                                          Remarks
                                                                                                                                                                          +
                                                                                                                                                                          +Compares two Point objects. The return value is +based on the equivalence of the X and Y properties +of the two points. +
                                                                                                                                                                          + +

                                                                                                                                                                          Explicit(Point to Size)

                                                                                                                                                                          +
                                                                                                                                                                          +Point to Size Conversion +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public static explicit operator Size(Point p)
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Parameters
                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                          Pointp
                                                                                                                                                                          +
                                                                                                                                                                          Returns
                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                          TypeDescription
                                                                                                                                                                          Size
                                                                                                                                                                          +
                                                                                                                                                                          Remarks
                                                                                                                                                                          +
                                                                                                                                                                          +Returns a Size based on the Coordinates of a given +Point. Requires explicit cast. +
                                                                                                                                                                          + +

                                                                                                                                                                          Inequality(Point, Point)

                                                                                                                                                                          +
                                                                                                                                                                          +Inequality Operator +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public static bool operator !=(Point left, Point right)
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Parameters
                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                          Pointleft
                                                                                                                                                                          Pointright
                                                                                                                                                                          +
                                                                                                                                                                          Returns
                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                          TypeDescription
                                                                                                                                                                          System.Boolean
                                                                                                                                                                          +
                                                                                                                                                                          Remarks
                                                                                                                                                                          +
                                                                                                                                                                          +Compares two Point objects. The return value is +based on the equivalence of the X and Y properties +of the two points. +
                                                                                                                                                                          + +

                                                                                                                                                                          Subtraction(Point, Size)

                                                                                                                                                                          +
                                                                                                                                                                          +Subtraction Operator +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Declaration
                                                                                                                                                                          +
                                                                                                                                                                          + 
                                                                                                                                                                          public static Point operator -(Point pt, Size sz)
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          Parameters
                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                          Pointpt
                                                                                                                                                                          Sizesz
                                                                                                                                                                          +
                                                                                                                                                                          Returns
                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                          TypeDescription
                                                                                                                                                                          Point
                                                                                                                                                                          +
                                                                                                                                                                          Remarks
                                                                                                                                                                          +
                                                                                                                                                                          +Translates a Point using the negation of the Width +and Height properties of the given Size. +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          + + +
                                                                                                                                                                          +
                                                                                                                                                                          + + +
                                                                                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.PointF.html b/docs/api/Terminal.Gui/Terminal.Gui.PointF.html new file mode 100644 index 0000000000..90b5098439 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.PointF.html @@ -0,0 +1,908 @@ + + + + + + + + Struct PointF + + + + + + + + + + + + + + + + +
                                                                                                                                                                          +
                                                                                                                                                                          + + + +
                                                                                                                                                                          + +
                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                          + +
                                                                                                                                                                          +
                                                                                                                                                                          Search Results for
                                                                                                                                                                          +
                                                                                                                                                                          +

                                                                                                                                                                          +
                                                                                                                                                                          +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            + +
                                                                                                                                                                            + +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            + + +

                                                                                                                                                                            Struct PointF +

                                                                                                                                                                            +
                                                                                                                                                                            +Represents an ordered pair of x and y coordinates that define a point in a two-dimensional plane. +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Implements
                                                                                                                                                                            +
                                                                                                                                                                            System.IEquatable<PointF>
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Inherited Members
                                                                                                                                                                            +
                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                            +
                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                            +
                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Namespace: Terminal.Gui
                                                                                                                                                                            +
                                                                                                                                                                            Assembly: Terminal.Gui.dll
                                                                                                                                                                            +
                                                                                                                                                                            Syntax
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public struct PointF : IEquatable<PointF>
                                                                                                                                                                            +
                                                                                                                                                                            +

                                                                                                                                                                            Constructors +

                                                                                                                                                                            + +

                                                                                                                                                                            PointF(Single, Single)

                                                                                                                                                                            +
                                                                                                                                                                            +Initializes a new instance of the PointF class with the specified coordinates. +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public PointF(float x, float y)
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Parameters
                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                            System.Singlex
                                                                                                                                                                            System.Singley
                                                                                                                                                                            +

                                                                                                                                                                            Fields +

                                                                                                                                                                            +

                                                                                                                                                                            Empty

                                                                                                                                                                            +
                                                                                                                                                                            +Creates a new instance of the PointF class with member data left uninitialized. +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public static readonly PointF Empty
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Field Value
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            PointF
                                                                                                                                                                            +

                                                                                                                                                                            Properties +

                                                                                                                                                                            + +

                                                                                                                                                                            IsEmpty

                                                                                                                                                                            +
                                                                                                                                                                            +Gets a value indicating whether this PointF is empty. +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            [Browsable(false)]
+public readonly bool IsEmpty { get; }
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Property Value
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            System.Boolean
                                                                                                                                                                            + +

                                                                                                                                                                            X

                                                                                                                                                                            +
                                                                                                                                                                            +Gets the x-coordinate of this PointF. +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public float X { get; set; }
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Property Value
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            System.Single
                                                                                                                                                                            + +

                                                                                                                                                                            Y

                                                                                                                                                                            +
                                                                                                                                                                            +Gets the y-coordinate of this PointF. +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public float Y { get; set; }
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Property Value
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            System.Single
                                                                                                                                                                            +

                                                                                                                                                                            Methods +

                                                                                                                                                                            + +

                                                                                                                                                                            Add(PointF, Size)

                                                                                                                                                                            +
                                                                                                                                                                            +Translates a PointF by a given Size . +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public static PointF Add(PointF pt, Size sz)
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Parameters
                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                            PointFpt
                                                                                                                                                                            Sizesz
                                                                                                                                                                            +
                                                                                                                                                                            Returns
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            PointF
                                                                                                                                                                            + +

                                                                                                                                                                            Add(PointF, SizeF)

                                                                                                                                                                            +
                                                                                                                                                                            +Translates a PointF by a given SizeF . +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public static PointF Add(PointF pt, SizeF sz)
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Parameters
                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                            PointFpt
                                                                                                                                                                            SizeFsz
                                                                                                                                                                            +
                                                                                                                                                                            Returns
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            PointF
                                                                                                                                                                            + +

                                                                                                                                                                            Equals(Object)

                                                                                                                                                                            +
                                                                                                                                                                            +Compares two PointF objects. The result specifies whether the values of the +X and Y properties of the two +PointF objects are equal. +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public override bool Equals(object obj)
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Parameters
                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                            System.Objectobj
                                                                                                                                                                            +
                                                                                                                                                                            Returns
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            System.Boolean
                                                                                                                                                                            +
                                                                                                                                                                            Overrides
                                                                                                                                                                            +
                                                                                                                                                                            System.ValueType.Equals(System.Object)
                                                                                                                                                                            + +

                                                                                                                                                                            Equals(PointF)

                                                                                                                                                                            +
                                                                                                                                                                            +Compares two PointF objects. The result specifies whether the values of the +X and Y properties of the two +PointF objects are equal. +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public bool Equals(PointF other)
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Parameters
                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                            PointFother
                                                                                                                                                                            +
                                                                                                                                                                            Returns
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            System.Boolean
                                                                                                                                                                            + +

                                                                                                                                                                            GetHashCode()

                                                                                                                                                                            +
                                                                                                                                                                            +Generates a hashcode from the X and Y components +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public override int GetHashCode()
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Returns
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            System.Int32
                                                                                                                                                                            +
                                                                                                                                                                            Overrides
                                                                                                                                                                            +
                                                                                                                                                                            System.ValueType.GetHashCode()
                                                                                                                                                                            + +

                                                                                                                                                                            Subtract(PointF, Size)

                                                                                                                                                                            +
                                                                                                                                                                            +Translates a PointF by the negative of a given Size . +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public static PointF Subtract(PointF pt, Size sz)
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Parameters
                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                            PointFpt
                                                                                                                                                                            Sizesz
                                                                                                                                                                            +
                                                                                                                                                                            Returns
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            PointF
                                                                                                                                                                            + +

                                                                                                                                                                            Subtract(PointF, SizeF)

                                                                                                                                                                            +
                                                                                                                                                                            +Translates a PointF by the negative of a given SizeF . +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public static PointF Subtract(PointF pt, SizeF sz)
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Parameters
                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                            PointFpt
                                                                                                                                                                            SizeFsz
                                                                                                                                                                            +
                                                                                                                                                                            Returns
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            PointF
                                                                                                                                                                            + +

                                                                                                                                                                            ToString()

                                                                                                                                                                            +
                                                                                                                                                                            +Returns a string including the X and Y values +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public override string ToString()
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Returns
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            System.String
                                                                                                                                                                            +
                                                                                                                                                                            Overrides
                                                                                                                                                                            +
                                                                                                                                                                            System.ValueType.ToString()
                                                                                                                                                                            +

                                                                                                                                                                            Operators +

                                                                                                                                                                            + +

                                                                                                                                                                            Addition(PointF, Size)

                                                                                                                                                                            +
                                                                                                                                                                            +Translates a PointF by a given Size . +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public static PointF operator +(PointF pt, Size sz)
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Parameters
                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                            PointFpt
                                                                                                                                                                            Sizesz
                                                                                                                                                                            +
                                                                                                                                                                            Returns
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            PointF
                                                                                                                                                                            + +

                                                                                                                                                                            Addition(PointF, SizeF)

                                                                                                                                                                            +
                                                                                                                                                                            +Translates a PointF by a given SizeF . +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public static PointF operator +(PointF pt, SizeF sz)
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Parameters
                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                            PointFpt
                                                                                                                                                                            SizeFsz
                                                                                                                                                                            +
                                                                                                                                                                            Returns
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            PointF
                                                                                                                                                                            + +

                                                                                                                                                                            Equality(PointF, PointF)

                                                                                                                                                                            +
                                                                                                                                                                            +Compares two PointF objects. The result specifies whether the values of the +X and Y properties of the two +PointF objects are equal. +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public static bool operator ==(PointF left, PointF right)
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Parameters
                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                            PointFleft
                                                                                                                                                                            PointFright
                                                                                                                                                                            +
                                                                                                                                                                            Returns
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            System.Boolean
                                                                                                                                                                            + +

                                                                                                                                                                            Inequality(PointF, PointF)

                                                                                                                                                                            +
                                                                                                                                                                            +Compares two PointF objects. The result specifies whether the values of the +X or Y properties of the two +PointF objects are unequal. +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public static bool operator !=(PointF left, PointF right)
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Parameters
                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                            PointFleft
                                                                                                                                                                            PointFright
                                                                                                                                                                            +
                                                                                                                                                                            Returns
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            System.Boolean
                                                                                                                                                                            + +

                                                                                                                                                                            Subtraction(PointF, Size)

                                                                                                                                                                            +
                                                                                                                                                                            +Translates a PointF by the negative of a given Size . +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public static PointF operator -(PointF pt, Size sz)
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Parameters
                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                            PointFpt
                                                                                                                                                                            Sizesz
                                                                                                                                                                            +
                                                                                                                                                                            Returns
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            PointF
                                                                                                                                                                            + +

                                                                                                                                                                            Subtraction(PointF, SizeF)

                                                                                                                                                                            +
                                                                                                                                                                            +Translates a PointF by the negative of a given SizeF . +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Declaration
                                                                                                                                                                            +
                                                                                                                                                                            + 
                                                                                                                                                                            public static PointF operator -(PointF pt, SizeF sz)
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            Parameters
                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                            PointFpt
                                                                                                                                                                            SizeFsz
                                                                                                                                                                            +
                                                                                                                                                                            Returns
                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                            TypeDescription
                                                                                                                                                                            PointF
                                                                                                                                                                            +

                                                                                                                                                                            Implements

                                                                                                                                                                            +
                                                                                                                                                                            + System.IEquatable<T> +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            + + +
                                                                                                                                                                            +
                                                                                                                                                                            + + +
                                                                                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Pos.html b/docs/api/Terminal.Gui/Terminal.Gui.Pos.html new file mode 100644 index 0000000000..e9cda06a33 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Pos.html @@ -0,0 +1,855 @@ + + + + + + + + Class Pos + + + + + + + + + + + + + + + + +
                                                                                                                                                                            +
                                                                                                                                                                            + + + +
                                                                                                                                                                            + +
                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                            + +
                                                                                                                                                                            +
                                                                                                                                                                            Search Results for
                                                                                                                                                                            +
                                                                                                                                                                            +

                                                                                                                                                                            +
                                                                                                                                                                            +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + + +

                                                                                                                                                                              Class Pos +

                                                                                                                                                                              +
                                                                                                                                                                              +Describes the position of a View which can be an absolute value, a percentage, centered, or +relative to the ending dimension. Integer values are implicitly convertible to +an absolute Pos. These objects are created using the static methods Percent, +AnchorEnd, and Center. The Pos objects can be combined with the addition and +subtraction operators. +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Inheritance
                                                                                                                                                                              +
                                                                                                                                                                              System.Object
                                                                                                                                                                              +
                                                                                                                                                                              Pos
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Inherited Members
                                                                                                                                                                              +
                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                              +
                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                              +
                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                              +
                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                              +
                                                                                                                                                                              + System.Object.ToString() +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Namespace: Terminal.Gui
                                                                                                                                                                              +
                                                                                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                                                                                              +
                                                                                                                                                                              Syntax
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public class Pos
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Remarks
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              + Use the Pos objects on the X or Y properties of a view to control the position. +

                                                                                                                                                                              +

                                                                                                                                                                              + These can be used to set the absolute position, when merely assigning an + integer value (via the implicit integer to Pos conversion), and they can be combined + to produce more useful layouts, like: Pos.Center - 3, which would shift the position + of the View 3 characters to the left after centering for example. +

                                                                                                                                                                              +

                                                                                                                                                                              + It is possible to reference coordinates of another view by using the methods + Left(View), Right(View), Bottom(View), Top(View). The X(View) and Y(View) are + aliases to Left(View) and Top(View) respectively. +

                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              Methods +

                                                                                                                                                                              + +

                                                                                                                                                                              AnchorEnd(Int32)

                                                                                                                                                                              +
                                                                                                                                                                              +Creates a Pos object that is anchored to the end (right side or bottom) of the dimension, +useful to flush the layout from the right or bottom. +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public static Pos AnchorEnd(int margin = 0)
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Parameters
                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                              System.Int32marginOptional margin to place to the right or below.
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              PosThe Pos object anchored to the end (the bottom or the right side).
                                                                                                                                                                              +
                                                                                                                                                                              Examples
                                                                                                                                                                              + +This sample shows how align a Button to the bottom-right of a View. +
                                                                                                                                                                              // See Issue #502 
+anchorButton.X = Pos.AnchorEnd () - (Pos.Right (anchorButton) - Pos.Left (anchorButton));
+anchorButton.Y = Pos.AnchorEnd (1);
                                                                                                                                                                              + + +

                                                                                                                                                                              At(Int32)

                                                                                                                                                                              +
                                                                                                                                                                              +Creates an Absolute Pos from the specified integer value. +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public static Pos At(int n)
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Parameters
                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                              System.Int32nThe value to convert to the Pos.
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              PosThe Absolute Pos.
                                                                                                                                                                              + +

                                                                                                                                                                              Bottom(View)

                                                                                                                                                                              +
                                                                                                                                                                              +Returns a Pos object tracks the Bottom (Y+Height) coordinate of the specified View +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public static Pos Bottom(View view)
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Parameters
                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                              ViewviewThe View that will be tracked.
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              PosThe Pos that depends on the other view.
                                                                                                                                                                              + +

                                                                                                                                                                              Center()

                                                                                                                                                                              +
                                                                                                                                                                              +Returns a Pos object that can be used to center the View +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public static Pos Center()
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              PosThe center Pos.
                                                                                                                                                                              +
                                                                                                                                                                              Examples
                                                                                                                                                                              + +This creates a TextFieldthat is centered horizontally, is 50% of the way down, +is 30% the height, and is 80% the width of the View it added to. +
                                                                                                                                                                              var textView = new TextView () {
+X = Pos.Center (),
+Y = Pos.Percent (50),
+Width = Dim.Percent (80),
+	Height = Dim.Percent (30),
+};
                                                                                                                                                                              + + +

                                                                                                                                                                              Equals(Object)

                                                                                                                                                                              +
                                                                                                                                                                              Determines whether the specified object is equal to the current object.
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public override bool Equals(object other)
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Parameters
                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                              System.ObjectotherThe object to compare with the current object.
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              System.Boolean +true if the specified object is equal to the current object; otherwise, false.
                                                                                                                                                                              +
                                                                                                                                                                              Overrides
                                                                                                                                                                              +
                                                                                                                                                                              System.Object.Equals(System.Object)
                                                                                                                                                                              + +

                                                                                                                                                                              Function(Func<Int32>)

                                                                                                                                                                              +
                                                                                                                                                                              +Creates a "PosFunc" from the specified function. +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public static Pos Function(Func<int> function)
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Parameters
                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                              System.Func<System.Int32>functionThe function to be executed.
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              PosThe Pos returned from the function.
                                                                                                                                                                              + +

                                                                                                                                                                              GetHashCode()

                                                                                                                                                                              +
                                                                                                                                                                              Serves as the default hash function.
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public override int GetHashCode()
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              System.Int32A hash code for the current object.
                                                                                                                                                                              +
                                                                                                                                                                              Overrides
                                                                                                                                                                              +
                                                                                                                                                                              System.Object.GetHashCode()
                                                                                                                                                                              + +

                                                                                                                                                                              Left(View)

                                                                                                                                                                              +
                                                                                                                                                                              +Returns a Pos object tracks the Left (X) position of the specified View. +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public static Pos Left(View view)
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Parameters
                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                              ViewviewThe View that will be tracked.
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              PosThe Pos that depends on the other view.
                                                                                                                                                                              + +

                                                                                                                                                                              Percent(Single)

                                                                                                                                                                              +
                                                                                                                                                                              +Creates a percentage Pos object +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public static Pos Percent(float n)
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Parameters
                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                              System.SinglenA value between 0 and 100 representing the percentage.
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              PosThe percent Pos object.
                                                                                                                                                                              +
                                                                                                                                                                              Examples
                                                                                                                                                                              + +This creates a TextFieldthat is centered horizontally, is 50% of the way down, +is 30% the height, and is 80% the width of the View it added to. +
                                                                                                                                                                              var textView = new TextView () {
+X = Pos.Center (),
+Y = Pos.Percent (50),
+Width = Dim.Percent (80),
+	Height = Dim.Percent (30),
+};
                                                                                                                                                                              + + +

                                                                                                                                                                              Right(View)

                                                                                                                                                                              +
                                                                                                                                                                              +Returns a Pos object tracks the Right (X+Width) coordinate of the specified View. +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public static Pos Right(View view)
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Parameters
                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                              ViewviewThe View that will be tracked.
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              PosThe Pos that depends on the other view.
                                                                                                                                                                              + +

                                                                                                                                                                              Top(View)

                                                                                                                                                                              +
                                                                                                                                                                              +Returns a Pos object tracks the Top (Y) position of the specified View. +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public static Pos Top(View view)
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Parameters
                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                              ViewviewThe View that will be tracked.
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              PosThe Pos that depends on the other view.
                                                                                                                                                                              + +

                                                                                                                                                                              X(View)

                                                                                                                                                                              +
                                                                                                                                                                              +Returns a Pos object tracks the Left (X) position of the specified View. +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public static Pos X(View view)
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Parameters
                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                              ViewviewThe View that will be tracked.
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              PosThe Pos that depends on the other view.
                                                                                                                                                                              + +

                                                                                                                                                                              Y(View)

                                                                                                                                                                              +
                                                                                                                                                                              +Returns a Pos object tracks the Top (Y) position of the specified View. +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public static Pos Y(View view)
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Parameters
                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                              ViewviewThe View that will be tracked.
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              PosThe Pos that depends on the other view.
                                                                                                                                                                              +

                                                                                                                                                                              Operators +

                                                                                                                                                                              + +

                                                                                                                                                                              Addition(Pos, Pos)

                                                                                                                                                                              +
                                                                                                                                                                              +Adds a Pos to a Pos, yielding a new Pos. +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public static Pos operator +(Pos left, Pos right)
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Parameters
                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                              PosleftThe first Pos to add.
                                                                                                                                                                              PosrightThe second Pos to add.
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              PosThe Pos that is the sum of the values of left and right.
                                                                                                                                                                              + +

                                                                                                                                                                              Implicit(Int32 to Pos)

                                                                                                                                                                              +
                                                                                                                                                                              +Creates an Absolute Pos from the specified integer value. +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public static implicit operator Pos(int n)
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Parameters
                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                              System.Int32nThe value to convert to the Pos .
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              PosThe Absolute Pos.
                                                                                                                                                                              + +

                                                                                                                                                                              Subtraction(Pos, Pos)

                                                                                                                                                                              +
                                                                                                                                                                              +Subtracts a Pos from a Pos, yielding a new Pos. +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Declaration
                                                                                                                                                                              +
                                                                                                                                                                              + 
                                                                                                                                                                              public static Pos operator -(Pos left, Pos right)
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              Parameters
                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                              PosleftThe Pos to subtract from (the minuend).
                                                                                                                                                                              PosrightThe Pos to subtract (the subtrahend).
                                                                                                                                                                              +
                                                                                                                                                                              Returns
                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                              TypeDescription
                                                                                                                                                                              PosThe Pos that is the left minus right.
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + + +
                                                                                                                                                                              +
                                                                                                                                                                              + + +
                                                                                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ProgressBar.html b/docs/api/Terminal.Gui/Terminal.Gui.ProgressBar.html new file mode 100644 index 0000000000..95d4e74249 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ProgressBar.html @@ -0,0 +1,873 @@ + + + + + + + + Class ProgressBar + + + + + + + + + + + + + + + + +
                                                                                                                                                                              +
                                                                                                                                                                              + + + +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              Search Results for
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + + +

                                                                                                                                                                                Class ProgressBar +

                                                                                                                                                                                +
                                                                                                                                                                                +A Progress Bar view that can indicate progress of an activity visually. +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Inheritance
                                                                                                                                                                                +
                                                                                                                                                                                System.Object
                                                                                                                                                                                +
                                                                                                                                                                                Responder
                                                                                                                                                                                +
                                                                                                                                                                                View
                                                                                                                                                                                +
                                                                                                                                                                                ProgressBar
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Implements
                                                                                                                                                                                +
                                                                                                                                                                                System.IDisposable
                                                                                                                                                                                +
                                                                                                                                                                                System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                +
                                                                                                                                                                                System.ComponentModel.ISupportInitialize
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Inherited Members
                                                                                                                                                                                + + + + + + + + + + + + + + + + +
                                                                                                                                                                                + View.Data +
                                                                                                                                                                                + + + + + + +
                                                                                                                                                                                + View.Id +
                                                                                                                                                                                + + + + + + +
                                                                                                                                                                                + View.X +
                                                                                                                                                                                +
                                                                                                                                                                                + View.Y +
                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                +
                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                +
                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                +
                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                +
                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                +
                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Namespace: Terminal.Gui
                                                                                                                                                                                +
                                                                                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                                                                                +
                                                                                                                                                                                Syntax
                                                                                                                                                                                +
                                                                                                                                                                                + 
                                                                                                                                                                                public class ProgressBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Remarks
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                +ProgressBar can operate in two modes, percentage mode, or +activity mode. The progress bar starts in percentage mode and +setting the Fraction property will reflect on the UI the progress +made so far. Activity mode is used when the application has no +way of knowing how much time is left, and is started when the Pulse() method is called. +Call Pulse() repeatedly as progress is made. +

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Constructors +

                                                                                                                                                                                + +

                                                                                                                                                                                ProgressBar()

                                                                                                                                                                                +
                                                                                                                                                                                +Initializes a new instance of the ProgressBar class, starts in percentage mode and uses relative layout. +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Declaration
                                                                                                                                                                                +
                                                                                                                                                                                + 
                                                                                                                                                                                public ProgressBar()
                                                                                                                                                                                +
                                                                                                                                                                                + +

                                                                                                                                                                                ProgressBar(Rect)

                                                                                                                                                                                +
                                                                                                                                                                                +Initializes a new instance of the ProgressBar class, starts in percentage mode with an absolute position and size. +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Declaration
                                                                                                                                                                                +
                                                                                                                                                                                + 
                                                                                                                                                                                public ProgressBar(Rect rect)
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Parameters
                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                RectrectRect.
                                                                                                                                                                                +

                                                                                                                                                                                Properties +

                                                                                                                                                                                + +

                                                                                                                                                                                BidirectionalMarquee

                                                                                                                                                                                +
                                                                                                                                                                                +Specifies if the MarqueeBlocks or the +MarqueeContinuous styles is unidirectional +or bidirectional. +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Declaration
                                                                                                                                                                                +
                                                                                                                                                                                + 
                                                                                                                                                                                public bool BidirectionalMarquee { get; set; }
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Property Value
                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                TypeDescription
                                                                                                                                                                                System.Boolean
                                                                                                                                                                                + +

                                                                                                                                                                                Fraction

                                                                                                                                                                                +
                                                                                                                                                                                +Gets or sets the ProgressBar fraction to display, must be a value between 0 and 1. +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Declaration
                                                                                                                                                                                +
                                                                                                                                                                                + 
                                                                                                                                                                                public float Fraction { get; set; }
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Property Value
                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                TypeDescription
                                                                                                                                                                                System.SingleThe fraction representing the progress.
                                                                                                                                                                                + +

                                                                                                                                                                                ProgressBarFormat

                                                                                                                                                                                +
                                                                                                                                                                                +Specifies the format that a ProgressBar uses to indicate the visual presentation. +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Declaration
                                                                                                                                                                                +
                                                                                                                                                                                + 
                                                                                                                                                                                public ProgressBarFormat ProgressBarFormat { get; set; }
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Property Value
                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                TypeDescription
                                                                                                                                                                                ProgressBarFormat
                                                                                                                                                                                + +

                                                                                                                                                                                ProgressBarStyle

                                                                                                                                                                                +
                                                                                                                                                                                +Gets/Sets the progress bar style based on the ProgressBarStyle +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Declaration
                                                                                                                                                                                +
                                                                                                                                                                                + 
                                                                                                                                                                                public ProgressBarStyle ProgressBarStyle { get; set; }
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Property Value
                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                TypeDescription
                                                                                                                                                                                ProgressBarStyle
                                                                                                                                                                                + +

                                                                                                                                                                                SegmentCharacter

                                                                                                                                                                                +
                                                                                                                                                                                +Segment indicator for meter views. +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Declaration
                                                                                                                                                                                +
                                                                                                                                                                                + 
                                                                                                                                                                                public Rune SegmentCharacter { get; set; }
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Property Value
                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                TypeDescription
                                                                                                                                                                                System.Rune
                                                                                                                                                                                + +

                                                                                                                                                                                Text

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Declaration
                                                                                                                                                                                +
                                                                                                                                                                                + 
                                                                                                                                                                                public override ustring Text { get; set; }
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Property Value
                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                TypeDescription
                                                                                                                                                                                NStack.ustring
                                                                                                                                                                                +
                                                                                                                                                                                Overrides
                                                                                                                                                                                + +

                                                                                                                                                                                Methods +

                                                                                                                                                                                + +

                                                                                                                                                                                OnEnter(View)

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Declaration
                                                                                                                                                                                +
                                                                                                                                                                                + 
                                                                                                                                                                                public override bool OnEnter(View view)
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Parameters
                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                Viewview
                                                                                                                                                                                +
                                                                                                                                                                                Returns
                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                TypeDescription
                                                                                                                                                                                System.Boolean
                                                                                                                                                                                +
                                                                                                                                                                                Overrides
                                                                                                                                                                                + + +

                                                                                                                                                                                Pulse()

                                                                                                                                                                                +
                                                                                                                                                                                +Notifies the ProgressBar that some progress has taken place. +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Declaration
                                                                                                                                                                                +
                                                                                                                                                                                + 
                                                                                                                                                                                public void Pulse()
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Remarks
                                                                                                                                                                                +
                                                                                                                                                                                +If the ProgressBar is percentage mode, it switches to activity +mode. If is in activity mode, the marker is moved. +
                                                                                                                                                                                + +

                                                                                                                                                                                Redraw(Rect)

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Declaration
                                                                                                                                                                                +
                                                                                                                                                                                + 
                                                                                                                                                                                public override void Redraw(Rect region)
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                Parameters
                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                Rectregion
                                                                                                                                                                                +
                                                                                                                                                                                Overrides
                                                                                                                                                                                + +

                                                                                                                                                                                Implements

                                                                                                                                                                                +
                                                                                                                                                                                + System.IDisposable +
                                                                                                                                                                                +
                                                                                                                                                                                + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                +
                                                                                                                                                                                + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + + +
                                                                                                                                                                                +
                                                                                                                                                                                + + +
                                                                                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ProgressBarFormat.html b/docs/api/Terminal.Gui/Terminal.Gui.ProgressBarFormat.html new file mode 100644 index 0000000000..7b91bf2198 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ProgressBarFormat.html @@ -0,0 +1,170 @@ + + + + + + + + Enum ProgressBarFormat + + + + + + + + + + + + + + + + +
                                                                                                                                                                                +
                                                                                                                                                                                + + + +
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                Search Results for
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  + +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + + +

                                                                                                                                                                                  Enum ProgressBarFormat +

                                                                                                                                                                                  +
                                                                                                                                                                                  +Specifies the format that a ProgressBar uses to indicate the visual presentation. +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  Namespace: Terminal.Gui
                                                                                                                                                                                  +
                                                                                                                                                                                  Assembly: Terminal.Gui.dll
                                                                                                                                                                                  +
                                                                                                                                                                                  Syntax
                                                                                                                                                                                  +
                                                                                                                                                                                  + 
                                                                                                                                                                                  public enum ProgressBarFormat
                                                                                                                                                                                  +
                                                                                                                                                                                  +

                                                                                                                                                                                  Fields +

                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                  NameDescription
                                                                                                                                                                                  Framed +A framed visual presentation showing only the progress bar. +
                                                                                                                                                                                  FramedPlusPercentage +A framed visual presentation showing the progress bar and the percentage. +
                                                                                                                                                                                  FramedProgressPadded +A framed visual presentation showing all with the progress bar padded. +
                                                                                                                                                                                  Simple +A simple visual presentation showing only the progress bar. +
                                                                                                                                                                                  SimplePlusPercentage +A simple visual presentation showing the progress bar and the percentage. +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + + +
                                                                                                                                                                                  +
                                                                                                                                                                                  + + +
                                                                                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ProgressBarStyle.html b/docs/api/Terminal.Gui/Terminal.Gui.ProgressBarStyle.html new file mode 100644 index 0000000000..8337eca8b3 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ProgressBarStyle.html @@ -0,0 +1,164 @@ + + + + + + + + Enum ProgressBarStyle + + + + + + + + + + + + + + + + +
                                                                                                                                                                                  +
                                                                                                                                                                                  + + + +
                                                                                                                                                                                  + +
                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                  + +
                                                                                                                                                                                  +
                                                                                                                                                                                  Search Results for
                                                                                                                                                                                  +
                                                                                                                                                                                  +

                                                                                                                                                                                  +
                                                                                                                                                                                  +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    + +
                                                                                                                                                                                    + +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    + + +

                                                                                                                                                                                    Enum ProgressBarStyle +

                                                                                                                                                                                    +
                                                                                                                                                                                    +Specifies the style that a ProgressBar uses to indicate the progress of an operation. +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    Namespace: Terminal.Gui
                                                                                                                                                                                    +
                                                                                                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                                                                                                    +
                                                                                                                                                                                    Syntax
                                                                                                                                                                                    +
                                                                                                                                                                                    + 
                                                                                                                                                                                    public enum ProgressBarStyle
                                                                                                                                                                                    +
                                                                                                                                                                                    +

                                                                                                                                                                                    Fields +

                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                    NameDescription
                                                                                                                                                                                    Blocks +Indicates progress by increasing the number of segmented blocks in a ProgressBar. +
                                                                                                                                                                                    Continuous +Indicates progress by increasing the size of a smooth, continuous bar in a ProgressBar. +
                                                                                                                                                                                    MarqueeBlocks +Indicates progress by continuously scrolling a block across a ProgressBar in a marquee fashion. +
                                                                                                                                                                                    MarqueeContinuous +Indicates progress by continuously scrolling a block across a ProgressBar in a marquee fashion. +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    + + +
                                                                                                                                                                                    +
                                                                                                                                                                                    + + +
                                                                                                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.RadioGroup.html b/docs/api/Terminal.Gui/Terminal.Gui.RadioGroup.html new file mode 100644 index 0000000000..c0f4f9dd35 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.RadioGroup.html @@ -0,0 +1,1075 @@ + + + + + + + + Class RadioGroup + + + + + + + + + + + + + + + + +
                                                                                                                                                                                    +
                                                                                                                                                                                    + + + +
                                                                                                                                                                                    + +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    + +
                                                                                                                                                                                    +
                                                                                                                                                                                    Search Results for
                                                                                                                                                                                    +
                                                                                                                                                                                    +

                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      + +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      + + +

                                                                                                                                                                                      Class RadioGroup +

                                                                                                                                                                                      +
                                                                                                                                                                                      +RadioGroup shows a group of radio labels, only one of those can be selected at a given time +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Inheritance
                                                                                                                                                                                      +
                                                                                                                                                                                      System.Object
                                                                                                                                                                                      +
                                                                                                                                                                                      Responder
                                                                                                                                                                                      +
                                                                                                                                                                                      View
                                                                                                                                                                                      +
                                                                                                                                                                                      RadioGroup
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Implements
                                                                                                                                                                                      +
                                                                                                                                                                                      System.IDisposable
                                                                                                                                                                                      +
                                                                                                                                                                                      System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                      +
                                                                                                                                                                                      System.ComponentModel.ISupportInitialize
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                      + + + + + + + + + + + + + + + + +
                                                                                                                                                                                      + View.Data +
                                                                                                                                                                                      + + + + + + +
                                                                                                                                                                                      + View.Id +
                                                                                                                                                                                      + + + + + + +
                                                                                                                                                                                      + View.X +
                                                                                                                                                                                      +
                                                                                                                                                                                      + View.Y +
                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                      + View.Text +
                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                      +
                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                      +
                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                      +
                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                      +
                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                      +
                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Namespace: Terminal.Gui
                                                                                                                                                                                      +
                                                                                                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                                                                                                      +
                                                                                                                                                                                      Syntax
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public class RadioGroup : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                      +
                                                                                                                                                                                      +

                                                                                                                                                                                      Constructors +

                                                                                                                                                                                      + +

                                                                                                                                                                                      RadioGroup()

                                                                                                                                                                                      +
                                                                                                                                                                                      +Initializes a new instance of the RadioGroup class using Computed layout. +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public RadioGroup()
                                                                                                                                                                                      +
                                                                                                                                                                                      + +

                                                                                                                                                                                      RadioGroup(ustring[], Int32)

                                                                                                                                                                                      +
                                                                                                                                                                                      +Initializes a new instance of the RadioGroup class using Computed layout. +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public RadioGroup(ustring[] radioLabels, int selected = 0)
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Parameters
                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                      NStack.ustring[]radioLabelsThe radio labels; an array of strings that can contain hotkeys using an underscore before the letter.
                                                                                                                                                                                      System.Int32selectedThe index of the item to be selected, the value is clamped to the number of items.
                                                                                                                                                                                      + +

                                                                                                                                                                                      RadioGroup(Int32, Int32, ustring[], Int32)

                                                                                                                                                                                      +
                                                                                                                                                                                      +Initializes a new instance of the RadioGroup class using Absolute layout. +The View frame is computed from the provided radio labels. +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public RadioGroup(int x, int y, ustring[] radioLabels, int selected = 0)
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Parameters
                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                      System.Int32xThe x coordinate.
                                                                                                                                                                                      System.Int32yThe y coordinate.
                                                                                                                                                                                      NStack.ustring[]radioLabelsThe radio labels; an array of strings that can contain hotkeys using an underscore before the letter.
                                                                                                                                                                                      System.Int32selectedThe item to be selected, the value is clamped to the number of items.
                                                                                                                                                                                      + +

                                                                                                                                                                                      RadioGroup(Rect, ustring[], Int32)

                                                                                                                                                                                      +
                                                                                                                                                                                      +Initializes a new instance of the RadioGroup class using Absolute layout. +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public RadioGroup(Rect rect, ustring[] radioLabels, int selected = 0)
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Parameters
                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                      RectrectBoundaries for the radio group.
                                                                                                                                                                                      NStack.ustring[]radioLabelsThe radio labels; an array of strings that can contain hotkeys using an underscore before the letter.
                                                                                                                                                                                      System.Int32selectedThe index of item to be selected, the value is clamped to the number of items.
                                                                                                                                                                                      +

                                                                                                                                                                                      Properties +

                                                                                                                                                                                      + +

                                                                                                                                                                                      DisplayMode

                                                                                                                                                                                      +
                                                                                                                                                                                      +Gets or sets the DisplayModeLayout for this RadioGroup. +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public DisplayModeLayout DisplayMode { get; set; }
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Property Value
                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                      DisplayModeLayout
                                                                                                                                                                                      + +

                                                                                                                                                                                      HorizontalSpace

                                                                                                                                                                                      +
                                                                                                                                                                                      +Gets or sets the horizontal space for this RadioGroup if the DisplayMode is Horizontal +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public int HorizontalSpace { get; set; }
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Property Value
                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                      System.Int32
                                                                                                                                                                                      + +

                                                                                                                                                                                      RadioLabels

                                                                                                                                                                                      +
                                                                                                                                                                                      +The radio labels to display +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public ustring[] RadioLabels { get; set; }
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Property Value
                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                      NStack.ustring[]The radio labels.
                                                                                                                                                                                      + +

                                                                                                                                                                                      SelectedItem

                                                                                                                                                                                      +
                                                                                                                                                                                      +The currently selected item from the list of radio labels +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public int SelectedItem { get; set; }
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Property Value
                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                      System.Int32The selected.
                                                                                                                                                                                      +

                                                                                                                                                                                      Methods +

                                                                                                                                                                                      + +

                                                                                                                                                                                      MouseEvent(MouseEvent)

                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public override bool MouseEvent(MouseEvent me)
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Parameters
                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                      MouseEventme
                                                                                                                                                                                      +
                                                                                                                                                                                      Returns
                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                      System.Boolean
                                                                                                                                                                                      +
                                                                                                                                                                                      Overrides
                                                                                                                                                                                      + + +

                                                                                                                                                                                      OnEnter(View)

                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public override bool OnEnter(View view)
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Parameters
                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                      Viewview
                                                                                                                                                                                      +
                                                                                                                                                                                      Returns
                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                      System.Boolean
                                                                                                                                                                                      +
                                                                                                                                                                                      Overrides
                                                                                                                                                                                      + + +

                                                                                                                                                                                      OnSelectedItemChanged(Int32, Int32)

                                                                                                                                                                                      +
                                                                                                                                                                                      +Called whenever the current selected item changes. Invokes the SelectedItemChanged event. +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public virtual void OnSelectedItemChanged(int selectedItem, int previousSelectedItem)
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Parameters
                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                      System.Int32selectedItem
                                                                                                                                                                                      System.Int32previousSelectedItem
                                                                                                                                                                                      + +

                                                                                                                                                                                      PositionCursor()

                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public override void PositionCursor()
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Overrides
                                                                                                                                                                                      + + +

                                                                                                                                                                                      ProcessColdKey(KeyEvent)

                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public override bool ProcessColdKey(KeyEvent kb)
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Parameters
                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                      KeyEventkb
                                                                                                                                                                                      +
                                                                                                                                                                                      Returns
                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                      System.Boolean
                                                                                                                                                                                      +
                                                                                                                                                                                      Overrides
                                                                                                                                                                                      + + +

                                                                                                                                                                                      ProcessKey(KeyEvent)

                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public override bool ProcessKey(KeyEvent kb)
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Parameters
                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                      KeyEventkb
                                                                                                                                                                                      +
                                                                                                                                                                                      Returns
                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                      System.Boolean
                                                                                                                                                                                      +
                                                                                                                                                                                      Overrides
                                                                                                                                                                                      + + +

                                                                                                                                                                                      Redraw(Rect)

                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public override void Redraw(Rect bounds)
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Parameters
                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                      Rectbounds
                                                                                                                                                                                      +
                                                                                                                                                                                      Overrides
                                                                                                                                                                                      + + +

                                                                                                                                                                                      Refresh()

                                                                                                                                                                                      +
                                                                                                                                                                                      +Allow to invoke the SelectedItemChanged after their creation. +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public void Refresh()
                                                                                                                                                                                      +
                                                                                                                                                                                      +

                                                                                                                                                                                      Events +

                                                                                                                                                                                      +

                                                                                                                                                                                      SelectedItemChanged

                                                                                                                                                                                      +
                                                                                                                                                                                      +Invoked when the selected radio label has changed. +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Declaration
                                                                                                                                                                                      +
                                                                                                                                                                                      + 
                                                                                                                                                                                      public event Action<SelectedItemChangedArgs> SelectedItemChanged
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      Event Type
                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                      System.Action<SelectedItemChangedArgs>
                                                                                                                                                                                      +

                                                                                                                                                                                      Implements

                                                                                                                                                                                      +
                                                                                                                                                                                      + System.IDisposable +
                                                                                                                                                                                      +
                                                                                                                                                                                      + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                      +
                                                                                                                                                                                      + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      + + +
                                                                                                                                                                                      +
                                                                                                                                                                                      + + +
                                                                                                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Rect.html b/docs/api/Terminal.Gui/Terminal.Gui.Rect.html new file mode 100644 index 0000000000..63dee70663 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Rect.html @@ -0,0 +1,1361 @@ + + + + + + + + Struct Rect + + + + + + + + + + + + + + + + +
                                                                                                                                                                                      +
                                                                                                                                                                                      + + + +
                                                                                                                                                                                      + +
                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                      + +
                                                                                                                                                                                      +
                                                                                                                                                                                      Search Results for
                                                                                                                                                                                      +
                                                                                                                                                                                      +

                                                                                                                                                                                      +
                                                                                                                                                                                      +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        + +
                                                                                                                                                                                        + +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        + + +

                                                                                                                                                                                        Struct Rect +

                                                                                                                                                                                        +
                                                                                                                                                                                        +Stores a set of four integers that represent the location and size of a rectangle +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                        +
                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                        +
                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                        +
                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Namespace: Terminal.Gui
                                                                                                                                                                                        +
                                                                                                                                                                                        Assembly: Terminal.Gui.dll
                                                                                                                                                                                        +
                                                                                                                                                                                        Syntax
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public struct Rect
                                                                                                                                                                                        +
                                                                                                                                                                                        +

                                                                                                                                                                                        Constructors +

                                                                                                                                                                                        + +

                                                                                                                                                                                        Rect(Int32, Int32, Int32, Int32)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Rectangle Constructor +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public Rect(int x, int y, int width, int height)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        System.Int32x
                                                                                                                                                                                        System.Int32y
                                                                                                                                                                                        System.Int32width
                                                                                                                                                                                        System.Int32height
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Creates a Rectangle from a specified x,y location and +width and height values. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Rect(Point, Size)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Rectangle Constructor +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public Rect(Point location, Size size)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        Pointlocation
                                                                                                                                                                                        Sizesize
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Creates a Rectangle from Point and Size values. +
                                                                                                                                                                                        +

                                                                                                                                                                                        Fields +

                                                                                                                                                                                        +

                                                                                                                                                                                        Empty

                                                                                                                                                                                        +
                                                                                                                                                                                        +Empty Shared Field +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public static readonly Rect Empty
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Field Value
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        Rect
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +An uninitialized Rectangle Structure. +
                                                                                                                                                                                        +

                                                                                                                                                                                        X

                                                                                                                                                                                        +
                                                                                                                                                                                        +Gets or sets the x-coordinate of the upper-left corner of this Rectangle structure. +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public int X
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Field Value
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Int32
                                                                                                                                                                                        +

                                                                                                                                                                                        Y

                                                                                                                                                                                        +
                                                                                                                                                                                        +Gets or sets the y-coordinate of the upper-left corner of this Rectangle structure. +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public int Y
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Field Value
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Int32
                                                                                                                                                                                        +

                                                                                                                                                                                        Properties +

                                                                                                                                                                                        + +

                                                                                                                                                                                        Bottom

                                                                                                                                                                                        +
                                                                                                                                                                                        +Bottom Property +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public readonly int Bottom { get; }
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Property Value
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Int32
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +The Y coordinate of the bottom edge of the Rectangle. +Read only. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Height

                                                                                                                                                                                        +
                                                                                                                                                                                        +Gets or sets the height of this Rectangle structure. +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public int Height { get; set; }
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Property Value
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Int32
                                                                                                                                                                                        + +

                                                                                                                                                                                        IsEmpty

                                                                                                                                                                                        +
                                                                                                                                                                                        +IsEmpty Property +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public readonly bool IsEmpty { get; }
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Property Value
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Indicates if the width or height are zero. Read only. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Left

                                                                                                                                                                                        +
                                                                                                                                                                                        +Left Property +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public readonly int Left { get; }
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Property Value
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Int32
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +The X coordinate of the left edge of the Rectangle. +Read only. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Location

                                                                                                                                                                                        +
                                                                                                                                                                                        +Location Property +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public Point Location { get; set; }
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Property Value
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        Point
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +The Location of the top-left corner of the Rectangle. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Right

                                                                                                                                                                                        +
                                                                                                                                                                                        +Right Property +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public readonly int Right { get; }
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Property Value
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Int32
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +The X coordinate of the right edge of the Rectangle. +Read only. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Size

                                                                                                                                                                                        +
                                                                                                                                                                                        +Size Property +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public Size Size { get; set; }
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Property Value
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        Size
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +The Size of the Rectangle. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Top

                                                                                                                                                                                        +
                                                                                                                                                                                        +Top Property +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public readonly int Top { get; }
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Property Value
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Int32
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +The Y coordinate of the top edge of the Rectangle. +Read only. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Width

                                                                                                                                                                                        +
                                                                                                                                                                                        +Gets or sets the width of this Rect structure. +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public int Width { get; set; }
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Property Value
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Int32
                                                                                                                                                                                        +

                                                                                                                                                                                        Methods +

                                                                                                                                                                                        + +

                                                                                                                                                                                        Contains(Int32, Int32)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Contains Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public bool Contains(int x, int y)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        System.Int32x
                                                                                                                                                                                        System.Int32y
                                                                                                                                                                                        +
                                                                                                                                                                                        Returns
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Checks if an x,y coordinate lies within this Rectangle. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Contains(Point)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Contains Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public bool Contains(Point pt)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        Pointpt
                                                                                                                                                                                        +
                                                                                                                                                                                        Returns
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Checks if a Point lies within this Rectangle. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Contains(Rect)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Contains Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public bool Contains(Rect rect)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        Rectrect
                                                                                                                                                                                        +
                                                                                                                                                                                        Returns
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Checks if a Rectangle lies entirely within this +Rectangle. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Equals(Object)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Equals Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public override bool Equals(object obj)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        System.Objectobj
                                                                                                                                                                                        +
                                                                                                                                                                                        Returns
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                        +
                                                                                                                                                                                        Overrides
                                                                                                                                                                                        +
                                                                                                                                                                                        System.ValueType.Equals(System.Object)
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Checks equivalence of this Rectangle and another object. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        FromLTRB(Int32, Int32, Int32, Int32)

                                                                                                                                                                                        +
                                                                                                                                                                                        +FromLTRB Shared Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public static Rect FromLTRB(int left, int top, int right, int bottom)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        System.Int32left
                                                                                                                                                                                        System.Int32top
                                                                                                                                                                                        System.Int32right
                                                                                                                                                                                        System.Int32bottom
                                                                                                                                                                                        +
                                                                                                                                                                                        Returns
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        Rect
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Produces a Rectangle structure from left, top, right +and bottom coordinates. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        GetHashCode()

                                                                                                                                                                                        +
                                                                                                                                                                                        +GetHashCode Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public override int GetHashCode()
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Returns
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Int32
                                                                                                                                                                                        +
                                                                                                                                                                                        Overrides
                                                                                                                                                                                        +
                                                                                                                                                                                        System.ValueType.GetHashCode()
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Calculates a hashing value. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Inflate(Int32, Int32)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Inflate Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public void Inflate(int width, int height)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        System.Int32width
                                                                                                                                                                                        System.Int32height
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Inflates the Rectangle by a specified width and height. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Inflate(Rect, Int32, Int32)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Inflate Shared Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public static Rect Inflate(Rect rect, int x, int y)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        Rectrect
                                                                                                                                                                                        System.Int32x
                                                                                                                                                                                        System.Int32y
                                                                                                                                                                                        +
                                                                                                                                                                                        Returns
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        Rect
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Produces a new Rectangle by inflating an existing +Rectangle by the specified coordinate values. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Inflate(Size)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Inflate Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public void Inflate(Size size)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        Sizesize
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Inflates the Rectangle by a specified Size. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Intersect(Rect)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Intersect Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public void Intersect(Rect rect)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        Rectrect
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Replaces the Rectangle with the intersection of itself +and another Rectangle. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Intersect(Rect, Rect)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Intersect Shared Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public static Rect Intersect(Rect a, Rect b)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        Recta
                                                                                                                                                                                        Rectb
                                                                                                                                                                                        +
                                                                                                                                                                                        Returns
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        Rect
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Produces a new Rectangle by intersecting 2 existing +Rectangles. Returns null if there is no intersection. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        IntersectsWith(Rect)

                                                                                                                                                                                        +
                                                                                                                                                                                        +IntersectsWith Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public bool IntersectsWith(Rect rect)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        Rectrect
                                                                                                                                                                                        +
                                                                                                                                                                                        Returns
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Checks if a Rectangle intersects with this one. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Offset(Int32, Int32)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Offset Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public void Offset(int x, int y)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        System.Int32x
                                                                                                                                                                                        System.Int32y
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Moves the Rectangle a specified distance. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Offset(Point)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Offset Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public void Offset(Point pos)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        Pointpos
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Moves the Rectangle a specified distance. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        ToString()

                                                                                                                                                                                        +
                                                                                                                                                                                        +ToString Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public override string ToString()
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Returns
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.String
                                                                                                                                                                                        +
                                                                                                                                                                                        Overrides
                                                                                                                                                                                        +
                                                                                                                                                                                        System.ValueType.ToString()
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Formats the Rectangle as a string in (x,y,w,h) notation. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Union(Rect, Rect)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Union Shared Method +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public static Rect Union(Rect a, Rect b)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        Recta
                                                                                                                                                                                        Rectb
                                                                                                                                                                                        +
                                                                                                                                                                                        Returns
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        Rect
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Produces a new Rectangle from the union of 2 existing +Rectangles. +
                                                                                                                                                                                        +

                                                                                                                                                                                        Operators +

                                                                                                                                                                                        + +

                                                                                                                                                                                        Equality(Rect, Rect)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Equality Operator +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public static bool operator ==(Rect left, Rect right)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        Rectleft
                                                                                                                                                                                        Rectright
                                                                                                                                                                                        +
                                                                                                                                                                                        Returns
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Compares two Rectangle objects. The return value is +based on the equivalence of the Location and Size +properties of the two Rectangles. +
                                                                                                                                                                                        + +

                                                                                                                                                                                        Inequality(Rect, Rect)

                                                                                                                                                                                        +
                                                                                                                                                                                        +Inequality Operator +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Declaration
                                                                                                                                                                                        +
                                                                                                                                                                                        + 
                                                                                                                                                                                        public static bool operator !=(Rect left, Rect right)
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        Parameters
                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                        Rectleft
                                                                                                                                                                                        Rectright
                                                                                                                                                                                        +
                                                                                                                                                                                        Returns
                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                        +
                                                                                                                                                                                        Remarks
                                                                                                                                                                                        +
                                                                                                                                                                                        +Compares two Rectangle objects. The return value is +based on the equivalence of the Location and Size +properties of the two Rectangles. +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        + + +
                                                                                                                                                                                        +
                                                                                                                                                                                        + + +
                                                                                                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.RectangleF.html b/docs/api/Terminal.Gui/Terminal.Gui.RectangleF.html new file mode 100644 index 0000000000..f15336efc9 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.RectangleF.html @@ -0,0 +1,1351 @@ + + + + + + + + Struct RectangleF + + + + + + + + + + + + + + + + +
                                                                                                                                                                                        +
                                                                                                                                                                                        + + + +
                                                                                                                                                                                        + +
                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                        + +
                                                                                                                                                                                        +
                                                                                                                                                                                        Search Results for
                                                                                                                                                                                        +
                                                                                                                                                                                        +

                                                                                                                                                                                        +
                                                                                                                                                                                        +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          + +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          + + +

                                                                                                                                                                                          Struct RectangleF +

                                                                                                                                                                                          +
                                                                                                                                                                                          +Stores the location and size of a rectangular region. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Implements
                                                                                                                                                                                          +
                                                                                                                                                                                          System.IEquatable<RectangleF>
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                          +
                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                          +
                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                          +
                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Namespace: Terminal.Gui
                                                                                                                                                                                          +
                                                                                                                                                                                          Assembly: Terminal.Gui.dll
                                                                                                                                                                                          +
                                                                                                                                                                                          Syntax
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public struct RectangleF : IEquatable<RectangleF>
                                                                                                                                                                                          +
                                                                                                                                                                                          +

                                                                                                                                                                                          Constructors +

                                                                                                                                                                                          + +

                                                                                                                                                                                          RectangleF(Single, Single, Single, Single)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Initializes a new instance of the RectangleF class with the specified location +and size. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public RectangleF(float x, float y, float width, float height)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          System.Singlex
                                                                                                                                                                                          System.Singley
                                                                                                                                                                                          System.Singlewidth
                                                                                                                                                                                          System.Singleheight
                                                                                                                                                                                          + +

                                                                                                                                                                                          RectangleF(PointF, SizeF)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Initializes a new instance of the RectangleF class with the specified location +and size. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public RectangleF(PointF location, SizeF size)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          PointFlocation
                                                                                                                                                                                          SizeFsize
                                                                                                                                                                                          +

                                                                                                                                                                                          Fields +

                                                                                                                                                                                          +

                                                                                                                                                                                          Empty

                                                                                                                                                                                          +
                                                                                                                                                                                          +Initializes a new instance of the RectangleF class. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public static readonly RectangleF Empty
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Field Value
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          RectangleF
                                                                                                                                                                                          +

                                                                                                                                                                                          Properties +

                                                                                                                                                                                          + +

                                                                                                                                                                                          Bottom

                                                                                                                                                                                          +
                                                                                                                                                                                          +Gets the y-coordinate of the lower-right corner of the rectangular region defined by this +RectangleF. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          [Browsable(false)]
+public readonly float Bottom { get; }
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Property Value
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Single
                                                                                                                                                                                          + +

                                                                                                                                                                                          Height

                                                                                                                                                                                          +
                                                                                                                                                                                          +Gets or sets the height of the rectangular region defined by this RectangleF. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public float Height { get; set; }
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Property Value
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Single
                                                                                                                                                                                          + +

                                                                                                                                                                                          IsEmpty

                                                                                                                                                                                          +
                                                                                                                                                                                          +Tests whether this RectangleF has a Width or a Height of 0. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          [Browsable(false)]
+public readonly bool IsEmpty { get; }
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Property Value
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                          + +

                                                                                                                                                                                          Left

                                                                                                                                                                                          +
                                                                                                                                                                                          +Gets the x-coordinate of the upper-left corner of the rectangular region defined by this +RectangleF . +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          [Browsable(false)]
+public readonly float Left { get; }
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Property Value
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Single
                                                                                                                                                                                          + +

                                                                                                                                                                                          Location

                                                                                                                                                                                          +
                                                                                                                                                                                          +Gets or sets the coordinates of the upper-left corner of the rectangular region represented by this +RectangleF. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          [Browsable(false)]
+public PointF Location { get; set; }
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Property Value
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          PointF
                                                                                                                                                                                          + +

                                                                                                                                                                                          Right

                                                                                                                                                                                          +
                                                                                                                                                                                          +Gets the x-coordinate of the lower-right corner of the rectangular region defined by this +RectangleF. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          [Browsable(false)]
+public readonly float Right { get; }
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Property Value
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Single
                                                                                                                                                                                          + +

                                                                                                                                                                                          Size

                                                                                                                                                                                          +
                                                                                                                                                                                          +Gets or sets the size of this RectangleF. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          [Browsable(false)]
+public SizeF Size { get; set; }
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Property Value
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          SizeF
                                                                                                                                                                                          + +

                                                                                                                                                                                          Top

                                                                                                                                                                                          +
                                                                                                                                                                                          +Gets the y-coordinate of the upper-left corner of the rectangular region defined by this +RectangleF. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          [Browsable(false)]
+public readonly float Top { get; }
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Property Value
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Single
                                                                                                                                                                                          + +

                                                                                                                                                                                          Width

                                                                                                                                                                                          +
                                                                                                                                                                                          +Gets or sets the width of the rectangular region defined by this RectangleF. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public float Width { get; set; }
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Property Value
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Single
                                                                                                                                                                                          + +

                                                                                                                                                                                          X

                                                                                                                                                                                          +
                                                                                                                                                                                          +Gets or sets the x-coordinate of the upper-left corner of the rectangular region defined by this +RectangleF. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public float X { get; set; }
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Property Value
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Single
                                                                                                                                                                                          + +

                                                                                                                                                                                          Y

                                                                                                                                                                                          +
                                                                                                                                                                                          +Gets or sets the y-coordinate of the upper-left corner of the rectangular region defined by this +RectangleF. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public float Y { get; set; }
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Property Value
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Single
                                                                                                                                                                                          +

                                                                                                                                                                                          Methods +

                                                                                                                                                                                          + +

                                                                                                                                                                                          Contains(Single, Single)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Determines if the specified point is contained within the rectangular region defined by this +Rect . +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public bool Contains(float x, float y)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          System.Singlex
                                                                                                                                                                                          System.Singley
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                          + +

                                                                                                                                                                                          Contains(PointF)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Determines if the specified point is contained within the rectangular region defined by this +Rect . +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public bool Contains(PointF pt)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          PointFpt
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                          + +

                                                                                                                                                                                          Contains(RectangleF)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Determines if the rectangular region represented by rect is entirely contained within +the rectangular region represented by this Rect . +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public bool Contains(RectangleF rect)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          RectangleFrect
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                          + +

                                                                                                                                                                                          Equals(Object)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Tests whether obj is a RectangleF with the same location and +size of this RectangleF. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public override bool Equals(object obj)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          System.Objectobj
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                          +
                                                                                                                                                                                          Overrides
                                                                                                                                                                                          +
                                                                                                                                                                                          System.ValueType.Equals(System.Object)
                                                                                                                                                                                          + +

                                                                                                                                                                                          Equals(RectangleF)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Returns true if two RectangleF objects have equal location and size. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public bool Equals(RectangleF other)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          RectangleFother
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                          + +

                                                                                                                                                                                          FromLTRB(Single, Single, Single, Single)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Creates a new RectangleF with the specified location and size. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public static RectangleF FromLTRB(float left, float top, float right, float bottom)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          System.Singleleft
                                                                                                                                                                                          System.Singletop
                                                                                                                                                                                          System.Singleright
                                                                                                                                                                                          System.Singlebottom
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          RectangleF
                                                                                                                                                                                          + +

                                                                                                                                                                                          GetHashCode()

                                                                                                                                                                                          +
                                                                                                                                                                                          +Gets the hash code for this RectangleF. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public override int GetHashCode()
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Int32
                                                                                                                                                                                          +
                                                                                                                                                                                          Overrides
                                                                                                                                                                                          +
                                                                                                                                                                                          System.ValueType.GetHashCode()
                                                                                                                                                                                          + +

                                                                                                                                                                                          Inflate(Single, Single)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Inflates this Rect by the specified amount. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public void Inflate(float x, float y)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          System.Singlex
                                                                                                                                                                                          System.Singley
                                                                                                                                                                                          + +

                                                                                                                                                                                          Inflate(RectangleF, Single, Single)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Creates a Rect that is inflated by the specified amount. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public static RectangleF Inflate(RectangleF rect, float x, float y)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          RectangleFrect
                                                                                                                                                                                          System.Singlex
                                                                                                                                                                                          System.Singley
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          RectangleF
                                                                                                                                                                                          + +

                                                                                                                                                                                          Inflate(SizeF)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Inflates this Rect by the specified amount. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public void Inflate(SizeF size)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          SizeFsize
                                                                                                                                                                                          + +

                                                                                                                                                                                          Intersect(RectangleF)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Creates a Rectangle that represents the intersection between this Rectangle and rect. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public void Intersect(RectangleF rect)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          RectangleFrect
                                                                                                                                                                                          + +

                                                                                                                                                                                          Intersect(RectangleF, RectangleF)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Creates a rectangle that represents the intersection between a and b. If there is no intersection, an +empty rectangle is returned. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public static RectangleF Intersect(RectangleF a, RectangleF b)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          RectangleFa
                                                                                                                                                                                          RectangleFb
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          RectangleF
                                                                                                                                                                                          + +

                                                                                                                                                                                          IntersectsWith(RectangleF)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Determines if this rectangle intersects with rect. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public bool IntersectsWith(RectangleF rect)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          RectangleFrect
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                          + +

                                                                                                                                                                                          Offset(Single, Single)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Adjusts the location of this rectangle by the specified amount. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public void Offset(float x, float y)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          System.Singlex
                                                                                                                                                                                          System.Singley
                                                                                                                                                                                          + +

                                                                                                                                                                                          Offset(PointF)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Adjusts the location of this rectangle by the specified amount. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public void Offset(PointF pos)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          PointFpos
                                                                                                                                                                                          + +

                                                                                                                                                                                          ToString()

                                                                                                                                                                                          +
                                                                                                                                                                                          +Converts the Location and Size +of this RectangleF to a human-readable string. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public override string ToString()
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.String
                                                                                                                                                                                          +
                                                                                                                                                                                          Overrides
                                                                                                                                                                                          +
                                                                                                                                                                                          System.ValueType.ToString()
                                                                                                                                                                                          + +

                                                                                                                                                                                          Union(RectangleF, RectangleF)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Creates a rectangle that represents the union between a and b. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public static RectangleF Union(RectangleF a, RectangleF b)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          RectangleFa
                                                                                                                                                                                          RectangleFb
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          RectangleF
                                                                                                                                                                                          +

                                                                                                                                                                                          Operators +

                                                                                                                                                                                          + +

                                                                                                                                                                                          Equality(RectangleF, RectangleF)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Tests whether two RectangleF objects have equal location and size. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public static bool operator ==(RectangleF left, RectangleF right)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          RectangleFleft
                                                                                                                                                                                          RectangleFright
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                          + +

                                                                                                                                                                                          Implicit(Rect to RectangleF)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Converts the specified Rect to a +RectangleF. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public static implicit operator RectangleF(Rect r)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          Rectr
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          RectangleF
                                                                                                                                                                                          + +

                                                                                                                                                                                          Inequality(RectangleF, RectangleF)

                                                                                                                                                                                          +
                                                                                                                                                                                          +Tests whether two RectangleF objects differ in location or size. +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Declaration
                                                                                                                                                                                          +
                                                                                                                                                                                          + 
                                                                                                                                                                                          public static bool operator !=(RectangleF left, RectangleF right)
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          Parameters
                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                          RectangleFleft
                                                                                                                                                                                          RectangleFright
                                                                                                                                                                                          +
                                                                                                                                                                                          Returns
                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                          +

                                                                                                                                                                                          Implements

                                                                                                                                                                                          +
                                                                                                                                                                                          + System.IEquatable<T> +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          + + +
                                                                                                                                                                                          +
                                                                                                                                                                                          + + +
                                                                                                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Responder.html b/docs/api/Terminal.Gui/Terminal.Gui.Responder.html new file mode 100644 index 0000000000..2355207f18 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Responder.html @@ -0,0 +1,824 @@ + + + + + + + + Class Responder + + + + + + + + + + + + + + + + +
                                                                                                                                                                                          +
                                                                                                                                                                                          + + + +
                                                                                                                                                                                          + +
                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                          + +
                                                                                                                                                                                          +
                                                                                                                                                                                          Search Results for
                                                                                                                                                                                          +
                                                                                                                                                                                          +

                                                                                                                                                                                          +
                                                                                                                                                                                          +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            + +
                                                                                                                                                                                            + +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            + + +

                                                                                                                                                                                            Class Responder +

                                                                                                                                                                                            +
                                                                                                                                                                                            +Responder base class implemented by objects that want to participate on keyboard and mouse input. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Inheritance
                                                                                                                                                                                            +
                                                                                                                                                                                            System.Object
                                                                                                                                                                                            +
                                                                                                                                                                                            Responder
                                                                                                                                                                                            +
                                                                                                                                                                                            View
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Implements
                                                                                                                                                                                            +
                                                                                                                                                                                            System.IDisposable
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                            +
                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                            +
                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                            +
                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                            +
                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                            +
                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                            +
                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                            +
                                                                                                                                                                                            + System.Object.ToString() +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Namespace: Terminal.Gui
                                                                                                                                                                                            +
                                                                                                                                                                                            Assembly: Terminal.Gui.dll
                                                                                                                                                                                            +
                                                                                                                                                                                            Syntax
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public class Responder : IDisposable
                                                                                                                                                                                            +
                                                                                                                                                                                            +

                                                                                                                                                                                            Properties +

                                                                                                                                                                                            + +

                                                                                                                                                                                            CanFocus

                                                                                                                                                                                            +
                                                                                                                                                                                            +Gets or sets a value indicating whether this Responder can focus. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual bool CanFocus { get; set; }
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Property Value
                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                            System.Booleantrue if can focus; otherwise, false.
                                                                                                                                                                                            + +

                                                                                                                                                                                            Enabled

                                                                                                                                                                                            +
                                                                                                                                                                                            +Gets or sets a value indicating whether this Responder can respond to user interaction. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual bool Enabled { get; set; }
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Property Value
                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                            + +

                                                                                                                                                                                            HasFocus

                                                                                                                                                                                            +
                                                                                                                                                                                            +Gets or sets a value indicating whether this Responder has focus. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual bool HasFocus { get; }
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Property Value
                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                            System.Booleantrue if has focus; otherwise, false.
                                                                                                                                                                                            + +

                                                                                                                                                                                            Visible

                                                                                                                                                                                            +
                                                                                                                                                                                            +Gets or sets a value indicating whether this Responder and all its child controls are displayed. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual bool Visible { get; set; }
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Property Value
                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                            +

                                                                                                                                                                                            Methods +

                                                                                                                                                                                            + +

                                                                                                                                                                                            Dispose()

                                                                                                                                                                                            +
                                                                                                                                                                                            +Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resource. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public void Dispose()
                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            Dispose(Boolean)

                                                                                                                                                                                            +
                                                                                                                                                                                            +Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            protected virtual void Dispose(bool disposing)
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Parameters
                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                            System.Booleandisposing
                                                                                                                                                                                            +
                                                                                                                                                                                            Remarks
                                                                                                                                                                                            +
                                                                                                                                                                                            +If disposing equals true, the method has been called directly +or indirectly by a user's code. Managed and unmanaged resources +can be disposed. +If disposing equals false, the method has been called by the +runtime from inside the finalizer and you should not reference +other objects. Only unmanaged resources can be disposed. +
                                                                                                                                                                                            + +

                                                                                                                                                                                            MouseEvent(MouseEvent)

                                                                                                                                                                                            +
                                                                                                                                                                                            +Method invoked when a mouse event is generated +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual bool MouseEvent(MouseEvent mouseEvent)
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Parameters
                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                            MouseEventmouseEventContains the details about the mouse event.
                                                                                                                                                                                            +
                                                                                                                                                                                            Returns
                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                            System.Booleantrue, if the event was handled, false otherwise.
                                                                                                                                                                                            + +

                                                                                                                                                                                            OnCanFocusChanged()

                                                                                                                                                                                            +
                                                                                                                                                                                            +Method invoked when the CanFocus property from a view is changed. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual void OnCanFocusChanged()
                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            OnEnabledChanged()

                                                                                                                                                                                            +
                                                                                                                                                                                            +Method invoked when the Enabled property from a view is changed. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual void OnEnabledChanged()
                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            OnEnter(View)

                                                                                                                                                                                            +
                                                                                                                                                                                            +Method invoked when a view gets focus. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual bool OnEnter(View view)
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Parameters
                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                            ViewviewThe view that is losing focus.
                                                                                                                                                                                            +
                                                                                                                                                                                            Returns
                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                            System.Booleantrue, if the event was handled, false otherwise.
                                                                                                                                                                                            + +

                                                                                                                                                                                            OnKeyDown(KeyEvent)

                                                                                                                                                                                            +
                                                                                                                                                                                            +Method invoked when a key is pressed. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual bool OnKeyDown(KeyEvent keyEvent)
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Parameters
                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                            KeyEventkeyEventContains the details about the key that produced the event.
                                                                                                                                                                                            +
                                                                                                                                                                                            Returns
                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                            System.Booleantrue if the event was handled
                                                                                                                                                                                            + +

                                                                                                                                                                                            OnKeyUp(KeyEvent)

                                                                                                                                                                                            +
                                                                                                                                                                                            +Method invoked when a key is released. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual bool OnKeyUp(KeyEvent keyEvent)
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Parameters
                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                            KeyEventkeyEventContains the details about the key that produced the event.
                                                                                                                                                                                            +
                                                                                                                                                                                            Returns
                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                            System.Booleantrue if the event was handled
                                                                                                                                                                                            + +

                                                                                                                                                                                            OnLeave(View)

                                                                                                                                                                                            +
                                                                                                                                                                                            +Method invoked when a view loses focus. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual bool OnLeave(View view)
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Parameters
                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                            ViewviewThe view that is getting focus.
                                                                                                                                                                                            +
                                                                                                                                                                                            Returns
                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                            System.Booleantrue, if the event was handled, false otherwise.
                                                                                                                                                                                            + +

                                                                                                                                                                                            OnMouseEnter(MouseEvent)

                                                                                                                                                                                            +
                                                                                                                                                                                            +Method invoked when a mouse event is generated for the first time. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual bool OnMouseEnter(MouseEvent mouseEvent)
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Parameters
                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                            MouseEventmouseEvent
                                                                                                                                                                                            +
                                                                                                                                                                                            Returns
                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                            System.Booleantrue, if the event was handled, false otherwise.
                                                                                                                                                                                            + +

                                                                                                                                                                                            OnMouseLeave(MouseEvent)

                                                                                                                                                                                            +
                                                                                                                                                                                            +Method invoked when a mouse event is generated for the last time. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual bool OnMouseLeave(MouseEvent mouseEvent)
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Parameters
                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                            MouseEventmouseEvent
                                                                                                                                                                                            +
                                                                                                                                                                                            Returns
                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                            System.Booleantrue, if the event was handled, false otherwise.
                                                                                                                                                                                            + +

                                                                                                                                                                                            OnVisibleChanged()

                                                                                                                                                                                            +
                                                                                                                                                                                            +Method invoked when the Visible property from a view is changed. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual void OnVisibleChanged()
                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            ProcessColdKey(KeyEvent)

                                                                                                                                                                                            +
                                                                                                                                                                                            +This method can be overwritten by views that +want to provide accelerator functionality +(Alt-key for example), but without +interefering with normal ProcessKey behavior. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual bool ProcessColdKey(KeyEvent keyEvent)
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Parameters
                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                            KeyEventkeyEventContains the details about the key that produced the event.
                                                                                                                                                                                            +
                                                                                                                                                                                            Returns
                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                            +
                                                                                                                                                                                            Remarks
                                                                                                                                                                                            +
                                                                                                                                                                                            +

                                                                                                                                                                                            + After keys are sent to the subviews on the + current view, all the view are + processed and the key is passed to the views + to allow some of them to process the keystroke + as a cold-key.

                                                                                                                                                                                            +

                                                                                                                                                                                            + This functionality is used, for example, by + default buttons to act on the enter key. + Processing this as a hot-key would prevent + non-default buttons from consuming the enter + keypress when they have the focus. +

                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            ProcessHotKey(KeyEvent)

                                                                                                                                                                                            +
                                                                                                                                                                                            +This method can be overwritten by view that +want to provide accelerator functionality +(Alt-key for example). +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual bool ProcessHotKey(KeyEvent kb)
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Parameters
                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                            KeyEventkb
                                                                                                                                                                                            +
                                                                                                                                                                                            Returns
                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                            +
                                                                                                                                                                                            Remarks
                                                                                                                                                                                            +
                                                                                                                                                                                            +

                                                                                                                                                                                            + Before keys are sent to the subview on the + current view, all the views are + processed and the key is passed to the widgets + to allow some of them to process the keystroke + as a hot-key.

                                                                                                                                                                                            +

                                                                                                                                                                                            + For example, if you implement a button that + has a hotkey ok "o", you would catch the + combination Alt-o here. If the event is + caught, you must return true to stop the + keystroke from being dispatched to other + views. +

                                                                                                                                                                                            +
                                                                                                                                                                                            + +

                                                                                                                                                                                            ProcessKey(KeyEvent)

                                                                                                                                                                                            +
                                                                                                                                                                                            +If the view is focused, gives the view a +chance to process the keystroke. +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Declaration
                                                                                                                                                                                            +
                                                                                                                                                                                            + 
                                                                                                                                                                                            public virtual bool ProcessKey(KeyEvent keyEvent)
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            Parameters
                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                            KeyEventkeyEventContains the details about the key that produced the event.
                                                                                                                                                                                            +
                                                                                                                                                                                            Returns
                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                            +
                                                                                                                                                                                            Remarks
                                                                                                                                                                                            +
                                                                                                                                                                                            +

                                                                                                                                                                                            + Views can override this method if they are + interested in processing the given keystroke. + If they consume the keystroke, they must + return true to stop the keystroke from being + processed by other widgets or consumed by the + widget engine. If they return false, the + keystroke will be passed using the ProcessColdKey + method to other views to process. +

                                                                                                                                                                                            +

                                                                                                                                                                                            + The View implementation does nothing but return false, + so it is not necessary to call base.ProcessKey if you + derive directly from View, but you should if you derive + other View subclasses. +

                                                                                                                                                                                            +
                                                                                                                                                                                            +

                                                                                                                                                                                            Implements

                                                                                                                                                                                            +
                                                                                                                                                                                            + System.IDisposable +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            + + +
                                                                                                                                                                                            +
                                                                                                                                                                                            + + +
                                                                                                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.SaveDialog.html b/docs/api/Terminal.Gui/Terminal.Gui.SaveDialog.html new file mode 100644 index 0000000000..60f9f0046d --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.SaveDialog.html @@ -0,0 +1,839 @@ + + + + + + + + Class SaveDialog + + + + + + + + + + + + + + + + +
                                                                                                                                                                                            +
                                                                                                                                                                                            + + + +
                                                                                                                                                                                            + +
                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                            + +
                                                                                                                                                                                            +
                                                                                                                                                                                            Search Results for
                                                                                                                                                                                            +
                                                                                                                                                                                            +

                                                                                                                                                                                            +
                                                                                                                                                                                            +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              + +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              + + +

                                                                                                                                                                                              Class SaveDialog +

                                                                                                                                                                                              +
                                                                                                                                                                                              +The SaveDialog provides an interactive dialog box for users to pick a file to +save. +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Inheritance
                                                                                                                                                                                              +
                                                                                                                                                                                              System.Object
                                                                                                                                                                                              +
                                                                                                                                                                                              Responder
                                                                                                                                                                                              +
                                                                                                                                                                                              View
                                                                                                                                                                                              +
                                                                                                                                                                                              Toplevel
                                                                                                                                                                                              +
                                                                                                                                                                                              Window
                                                                                                                                                                                              +
                                                                                                                                                                                              Dialog
                                                                                                                                                                                              +
                                                                                                                                                                                              FileDialog
                                                                                                                                                                                              +
                                                                                                                                                                                              SaveDialog
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Implements
                                                                                                                                                                                              +
                                                                                                                                                                                              System.IDisposable
                                                                                                                                                                                              +
                                                                                                                                                                                              System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                              +
                                                                                                                                                                                              System.ComponentModel.ISupportInitialize
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                              + View.Data +
                                                                                                                                                                                              + + + + + +
                                                                                                                                                                                              + View.Id +
                                                                                                                                                                                              + + + + + + +
                                                                                                                                                                                              + View.X +
                                                                                                                                                                                              +
                                                                                                                                                                                              + View.Y +
                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                              +
                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                              +
                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                              +
                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                              +
                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                              +
                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Namespace: Terminal.Gui
                                                                                                                                                                                              +
                                                                                                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                                                                                                              +
                                                                                                                                                                                              Syntax
                                                                                                                                                                                              +
                                                                                                                                                                                              + 
                                                                                                                                                                                              public class SaveDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Remarks
                                                                                                                                                                                              +
                                                                                                                                                                                              +

                                                                                                                                                                                              + To use, create an instance of SaveDialog, and pass it to +Run(Func<Exception, Boolean>). This will run the dialog modally, +and when this returns, the FileNameproperty will contain the selected file name or +null if the user canceled. +

                                                                                                                                                                                              +
                                                                                                                                                                                              +

                                                                                                                                                                                              Constructors +

                                                                                                                                                                                              + +

                                                                                                                                                                                              SaveDialog()

                                                                                                                                                                                              +
                                                                                                                                                                                              +Initializes a new SaveDialog. +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Declaration
                                                                                                                                                                                              +
                                                                                                                                                                                              + 
                                                                                                                                                                                              public SaveDialog()
                                                                                                                                                                                              +
                                                                                                                                                                                              + +

                                                                                                                                                                                              SaveDialog(ustring, ustring, List<String>)

                                                                                                                                                                                              +
                                                                                                                                                                                              +Initializes a new SaveDialog. +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Declaration
                                                                                                                                                                                              +
                                                                                                                                                                                              + 
                                                                                                                                                                                              public SaveDialog(ustring title, ustring message, List<string> allowedTypes = null)
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Parameters
                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                              NStack.ustringtitleThe title.
                                                                                                                                                                                              NStack.ustringmessageThe message.
                                                                                                                                                                                              System.Collections.Generic.List<System.String>allowedTypesThe allowed types.
                                                                                                                                                                                              +

                                                                                                                                                                                              Properties +

                                                                                                                                                                                              + +

                                                                                                                                                                                              FileName

                                                                                                                                                                                              +
                                                                                                                                                                                              +Gets the name of the file the user selected for saving, or null +if the user canceled the SaveDialog. +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Declaration
                                                                                                                                                                                              +
                                                                                                                                                                                              + 
                                                                                                                                                                                              public ustring FileName { get; }
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              Property Value
                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                              NStack.ustringThe name of the file.
                                                                                                                                                                                              +

                                                                                                                                                                                              Implements

                                                                                                                                                                                              +
                                                                                                                                                                                              + System.IDisposable +
                                                                                                                                                                                              +
                                                                                                                                                                                              + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                              +
                                                                                                                                                                                              + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              + + +
                                                                                                                                                                                              +
                                                                                                                                                                                              + + +
                                                                                                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html b/docs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html new file mode 100644 index 0000000000..807a3ed374 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html @@ -0,0 +1,1113 @@ + + + + + + + + Class ScrollBarView + + + + + + + + + + + + + + + + +
                                                                                                                                                                                              +
                                                                                                                                                                                              + + + +
                                                                                                                                                                                              + +
                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                              + +
                                                                                                                                                                                              +
                                                                                                                                                                                              Search Results for
                                                                                                                                                                                              +
                                                                                                                                                                                              +

                                                                                                                                                                                              +
                                                                                                                                                                                              +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                + +
                                                                                                                                                                                                + +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                + + +

                                                                                                                                                                                                Class ScrollBarView +

                                                                                                                                                                                                +
                                                                                                                                                                                                +ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                +
                                                                                                                                                                                                System.Object
                                                                                                                                                                                                +
                                                                                                                                                                                                Responder
                                                                                                                                                                                                +
                                                                                                                                                                                                View
                                                                                                                                                                                                +
                                                                                                                                                                                                ScrollBarView
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Implements
                                                                                                                                                                                                +
                                                                                                                                                                                                System.IDisposable
                                                                                                                                                                                                +
                                                                                                                                                                                                System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                +
                                                                                                                                                                                                System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                + View.Data +
                                                                                                                                                                                                + + + + + + +
                                                                                                                                                                                                + View.Id +
                                                                                                                                                                                                + + + + + + +
                                                                                                                                                                                                + View.X +
                                                                                                                                                                                                +
                                                                                                                                                                                                + View.Y +
                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                + View.Text +
                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                +
                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                +
                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                +
                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                +
                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                +
                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Namespace: Terminal.Gui
                                                                                                                                                                                                +
                                                                                                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                                                                                                +
                                                                                                                                                                                                Syntax
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public class ScrollBarView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Remarks
                                                                                                                                                                                                +
                                                                                                                                                                                                +

                                                                                                                                                                                                + The scrollbar is drawn to be a representation of the Size, assuming that the + scroll position is set at Position. +

                                                                                                                                                                                                +

                                                                                                                                                                                                + If the region to display the scrollbar is larger than three characters, + arrow indicators are drawn. +

                                                                                                                                                                                                +
                                                                                                                                                                                                +

                                                                                                                                                                                                Constructors +

                                                                                                                                                                                                + +

                                                                                                                                                                                                ScrollBarView()

                                                                                                                                                                                                +
                                                                                                                                                                                                +Initializes a new instance of the ScrollBarView class using Computed layout. +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public ScrollBarView()
                                                                                                                                                                                                +
                                                                                                                                                                                                + +

                                                                                                                                                                                                ScrollBarView(Int32, Int32, Boolean)

                                                                                                                                                                                                +
                                                                                                                                                                                                +Initializes a new instance of the ScrollBarView class using Computed layout. +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public ScrollBarView(int size, int position, bool isVertical)
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Parameters
                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                System.Int32sizeThe size that this scrollbar represents.
                                                                                                                                                                                                System.Int32positionThe position within this scrollbar.
                                                                                                                                                                                                System.BooleanisVerticalIf set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal.
                                                                                                                                                                                                + +

                                                                                                                                                                                                ScrollBarView(Rect)

                                                                                                                                                                                                +
                                                                                                                                                                                                +Initializes a new instance of the ScrollBarView class using Absolute layout. +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public ScrollBarView(Rect rect)
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Parameters
                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                RectrectFrame for the scrollbar.
                                                                                                                                                                                                + +

                                                                                                                                                                                                ScrollBarView(Rect, Int32, Int32, Boolean)

                                                                                                                                                                                                +
                                                                                                                                                                                                +Initializes a new instance of the ScrollBarView class using Absolute layout. +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public ScrollBarView(Rect rect, int size, int position, bool isVertical)
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Parameters
                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                RectrectFrame for the scrollbar.
                                                                                                                                                                                                System.Int32sizeThe size that this scrollbar represents. Sets the Size property.
                                                                                                                                                                                                System.Int32positionThe position within this scrollbar. Sets the Position property.
                                                                                                                                                                                                System.BooleanisVerticalIf set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. Sets the IsVertical property.
                                                                                                                                                                                                + +

                                                                                                                                                                                                ScrollBarView(View, Boolean, Boolean)

                                                                                                                                                                                                +
                                                                                                                                                                                                +Initializes a new instance of the ScrollBarView class using Computed layout. +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public ScrollBarView(View host, bool isVertical, bool showBothScrollIndicator = true)
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Parameters
                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                ViewhostThe view that will host this scrollbar.
                                                                                                                                                                                                System.BooleanisVerticalIf set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal.
                                                                                                                                                                                                System.BooleanshowBothScrollIndicatorIf set to true (default) will have the other scrollbar, otherwise will have only one.
                                                                                                                                                                                                +

                                                                                                                                                                                                Properties +

                                                                                                                                                                                                + +

                                                                                                                                                                                                AutoHideScrollBars

                                                                                                                                                                                                +
                                                                                                                                                                                                +If true the vertical/horizontal scroll bars won't be showed if it's not needed. +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public bool AutoHideScrollBars { get; set; }
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Property Value
                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                + +

                                                                                                                                                                                                Host

                                                                                                                                                                                                +
                                                                                                                                                                                                +Get or sets the view that host this View +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public View Host { get; }
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Property Value
                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                View
                                                                                                                                                                                                + +

                                                                                                                                                                                                IsVertical

                                                                                                                                                                                                +
                                                                                                                                                                                                +If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public bool IsVertical { get; set; }
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Property Value
                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                + +

                                                                                                                                                                                                KeepContentAlwaysInViewport

                                                                                                                                                                                                +
                                                                                                                                                                                                +Get or sets if the view-port is kept always visible in the area of this ScrollBarView +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public bool KeepContentAlwaysInViewport { get; set; }
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Property Value
                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                + +

                                                                                                                                                                                                OtherScrollBarView

                                                                                                                                                                                                +
                                                                                                                                                                                                +Represent a vertical or horizontal ScrollBarView other than this. +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public ScrollBarView OtherScrollBarView { get; set; }
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Property Value
                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                ScrollBarView
                                                                                                                                                                                                + +

                                                                                                                                                                                                Position

                                                                                                                                                                                                +
                                                                                                                                                                                                +The position, relative to Size, to set the scrollbar at. +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public int Position { get; set; }
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Property Value
                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                System.Int32The position.
                                                                                                                                                                                                + +

                                                                                                                                                                                                ShowScrollIndicator

                                                                                                                                                                                                +
                                                                                                                                                                                                +Gets or sets the visibility for the vertical or horizontal scroll indicator. +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public bool ShowScrollIndicator { get; set; }
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Property Value
                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                System.Booleantrue if show vertical or horizontal scroll indicator; otherwise, false.
                                                                                                                                                                                                + +

                                                                                                                                                                                                Size

                                                                                                                                                                                                +
                                                                                                                                                                                                +The size of content the scrollbar represents. +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public int Size { get; set; }
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Property Value
                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                System.Int32The size.
                                                                                                                                                                                                +
                                                                                                                                                                                                Remarks
                                                                                                                                                                                                +
                                                                                                                                                                                                The Size is typically the size of the virtual content. E.g. when a Scrollbar is +part of a View the Size is set to the appropriate dimension of Host.
                                                                                                                                                                                                +

                                                                                                                                                                                                Methods +

                                                                                                                                                                                                + +

                                                                                                                                                                                                MouseEvent(MouseEvent)

                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public override bool MouseEvent(MouseEvent me)
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Parameters
                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                MouseEventme
                                                                                                                                                                                                +
                                                                                                                                                                                                Returns
                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                +
                                                                                                                                                                                                Overrides
                                                                                                                                                                                                + + +

                                                                                                                                                                                                OnChangedPosition()

                                                                                                                                                                                                +
                                                                                                                                                                                                +Virtual method to invoke the ChangedPosition action event. +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public virtual void OnChangedPosition()
                                                                                                                                                                                                +
                                                                                                                                                                                                + +

                                                                                                                                                                                                OnEnter(View)

                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public override bool OnEnter(View view)
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Parameters
                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                Viewview
                                                                                                                                                                                                +
                                                                                                                                                                                                Returns
                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                +
                                                                                                                                                                                                Overrides
                                                                                                                                                                                                + + +

                                                                                                                                                                                                Redraw(Rect)

                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public override void Redraw(Rect region)
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Parameters
                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                Rectregion
                                                                                                                                                                                                +
                                                                                                                                                                                                Overrides
                                                                                                                                                                                                + + +

                                                                                                                                                                                                Refresh()

                                                                                                                                                                                                +
                                                                                                                                                                                                +Only used for a hosted view that will update and redraw the scrollbars. +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public virtual void Refresh()
                                                                                                                                                                                                +
                                                                                                                                                                                                +

                                                                                                                                                                                                Events +

                                                                                                                                                                                                +

                                                                                                                                                                                                ChangedPosition

                                                                                                                                                                                                +
                                                                                                                                                                                                +This event is raised when the position on the scrollbar has changed. +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Declaration
                                                                                                                                                                                                +
                                                                                                                                                                                                + 
                                                                                                                                                                                                public event Action ChangedPosition
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                Event Type
                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                System.Action
                                                                                                                                                                                                +

                                                                                                                                                                                                Implements

                                                                                                                                                                                                +
                                                                                                                                                                                                + System.IDisposable +
                                                                                                                                                                                                +
                                                                                                                                                                                                + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                +
                                                                                                                                                                                                + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                + + +
                                                                                                                                                                                                +
                                                                                                                                                                                                + + +
                                                                                                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html b/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html new file mode 100644 index 0000000000..0f0a7d5648 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html @@ -0,0 +1,1174 @@ + + + + + + + + Class ScrollView + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                +
                                                                                                                                                                                                + + + +
                                                                                                                                                                                                + +
                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                + +
                                                                                                                                                                                                +
                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                +
                                                                                                                                                                                                +

                                                                                                                                                                                                +
                                                                                                                                                                                                +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + + +

                                                                                                                                                                                                  Class ScrollView +

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView. +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                  +
                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Responder
                                                                                                                                                                                                  +
                                                                                                                                                                                                  View
                                                                                                                                                                                                  +
                                                                                                                                                                                                  ScrollView
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Implements
                                                                                                                                                                                                  +
                                                                                                                                                                                                  System.IDisposable
                                                                                                                                                                                                  +
                                                                                                                                                                                                  System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                  +
                                                                                                                                                                                                  System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                  + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  + View.Data +
                                                                                                                                                                                                  + + + + + + +
                                                                                                                                                                                                  + View.Id +
                                                                                                                                                                                                  + + + + + + +
                                                                                                                                                                                                  + View.X +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + View.Y +
                                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  + View.Text +
                                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Namespace: Terminal.Gui
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Assembly: Terminal.Gui.dll
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public class ScrollView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Remarks
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +

                                                                                                                                                                                                  + The subviews that are added to this ScrollView are offset by the +ContentOffset property. The view itself is a window into the +space represented by the ContentSize. +

                                                                                                                                                                                                  +

                                                                                                                                                                                                  + Use the +

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +

                                                                                                                                                                                                  Constructors +

                                                                                                                                                                                                  + +

                                                                                                                                                                                                  ScrollView()

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +Initializes a new instance of the ScrollView class using Computed positioning. +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public ScrollView()
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  ScrollView(Rect)

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +Initializes a new instance of the ScrollView class using Absolute positioning. +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public ScrollView(Rect frame)
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                  Rectframe
                                                                                                                                                                                                  +

                                                                                                                                                                                                  Properties +

                                                                                                                                                                                                  + +

                                                                                                                                                                                                  AutoHideScrollBars

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +If true the vertical/horizontal scroll bars won't be showed if it's not needed. +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public bool AutoHideScrollBars { get; set; }
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                  System.Boolean
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  ContentOffset

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +Represents the top left corner coordinate that is displayed by the scrollview +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public Point ContentOffset { get; set; }
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                  PointThe content offset.
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  ContentSize

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +Represents the contents of the data shown inside the scrollview +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public Size ContentSize { get; set; }
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                  SizeThe size of the content.
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  KeepContentAlwaysInViewport

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +Get or sets if the view-port is kept always visible in the area of this ScrollView +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public bool KeepContentAlwaysInViewport { get; set; }
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                  System.Boolean
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  ShowHorizontalScrollIndicator

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +Gets or sets the visibility for the horizontal scroll indicator. +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public bool ShowHorizontalScrollIndicator { get; set; }
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                  System.Booleantrue if show horizontal scroll indicator; otherwise, false.
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  ShowVerticalScrollIndicator

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +Gets or sets the visibility for the vertical scroll indicator. +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public bool ShowVerticalScrollIndicator { get; set; }
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                  System.Booleantrue if show vertical scroll indicator; otherwise, false.
                                                                                                                                                                                                  +

                                                                                                                                                                                                  Methods +

                                                                                                                                                                                                  + +

                                                                                                                                                                                                  Add(View)

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +Adds the view to the scrollview. +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public override void Add(View view)
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                  ViewviewThe view to add to the scrollview.
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                  + + +

                                                                                                                                                                                                  Dispose(Boolean)

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  protected override void Dispose(bool disposing)
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                  System.Booleandisposing
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                  + + +

                                                                                                                                                                                                  MouseEvent(MouseEvent)

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public override bool MouseEvent(MouseEvent me)
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                  MouseEventme
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Returns
                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                  System.Boolean
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                  + + +

                                                                                                                                                                                                  OnEnter(View)

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public override bool OnEnter(View view)
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                  Viewview
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Returns
                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                  System.Boolean
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                  + + +

                                                                                                                                                                                                  PositionCursor()

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public override void PositionCursor()
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                  + + +

                                                                                                                                                                                                  ProcessKey(KeyEvent)

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public override bool ProcessKey(KeyEvent kb)
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                  KeyEventkb
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Returns
                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                  System.Boolean
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                  + + +

                                                                                                                                                                                                  Redraw(Rect)

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public override void Redraw(Rect region)
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                  Rectregion
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                  + + +

                                                                                                                                                                                                  RemoveAll()

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +Removes all widgets from this container. +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public override void RemoveAll()
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  Remarks
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  ScrollDown(Int32)

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +Scrolls the view down. +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public bool ScrollDown(int lines)
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                  System.Int32linesNumber of lines to scroll.
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Returns
                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                  System.Booleantrue, if left was scrolled, false otherwise.
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  ScrollLeft(Int32)

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +Scrolls the view to the left +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public bool ScrollLeft(int cols)
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                  System.Int32colsNumber of columns to scroll by.
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Returns
                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                  System.Booleantrue, if left was scrolled, false otherwise.
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  ScrollRight(Int32)

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +Scrolls the view to the right. +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public bool ScrollRight(int cols)
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                  System.Int32colsNumber of columns to scroll by.
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Returns
                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                  System.Booleantrue, if right was scrolled, false otherwise.
                                                                                                                                                                                                  + +

                                                                                                                                                                                                  ScrollUp(Int32)

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +Scrolls the view up. +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + 
                                                                                                                                                                                                  public bool ScrollUp(int lines)
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                  System.Int32linesNumber of lines to scroll.
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Returns
                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                  System.Booleantrue, if left was scrolled, false otherwise.
                                                                                                                                                                                                  +

                                                                                                                                                                                                  Implements

                                                                                                                                                                                                  +
                                                                                                                                                                                                  + System.IDisposable +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + + +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + + +
                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.SelectedItemChangedArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.SelectedItemChangedArgs.html new file mode 100644 index 0000000000..c08ae169e0 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.SelectedItemChangedArgs.html @@ -0,0 +1,247 @@ + + + + + + + + Class SelectedItemChangedArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  + +
                                                                                                                                                                                                  +
                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                  +
                                                                                                                                                                                                  +

                                                                                                                                                                                                  +
                                                                                                                                                                                                  +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + +
                                                                                                                                                                                                    + +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + + +

                                                                                                                                                                                                    Class SelectedItemChangedArgs +

                                                                                                                                                                                                    +
                                                                                                                                                                                                    +Event arguments for the SelectedItemChagned event. +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                    +
                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                    +
                                                                                                                                                                                                    System.EventArgs
                                                                                                                                                                                                    +
                                                                                                                                                                                                    SelectedItemChangedArgs
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + System.EventArgs.Empty +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + System.Object.ToString() +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    Namespace: Terminal.Gui
                                                                                                                                                                                                    +
                                                                                                                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                                                                                                                    +
                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + 
                                                                                                                                                                                                    public class SelectedItemChangedArgs : EventArgs
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +

                                                                                                                                                                                                    Constructors +

                                                                                                                                                                                                    + +

                                                                                                                                                                                                    SelectedItemChangedArgs(Int32, Int32)

                                                                                                                                                                                                    +
                                                                                                                                                                                                    +Initializes a new SelectedItemChangedArgs class. +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + 
                                                                                                                                                                                                    public SelectedItemChangedArgs(int selectedItem, int previousSelectedItem)
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                    System.Int32selectedItem
                                                                                                                                                                                                    System.Int32previousSelectedItem
                                                                                                                                                                                                    +

                                                                                                                                                                                                    Properties +

                                                                                                                                                                                                    + +

                                                                                                                                                                                                    PreviousSelectedItem

                                                                                                                                                                                                    +
                                                                                                                                                                                                    +Gets the index of the item that was previously selected. -1 if there was no previous selection. +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + 
                                                                                                                                                                                                    public int PreviousSelectedItem { get; }
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                    + +

                                                                                                                                                                                                    SelectedItem

                                                                                                                                                                                                    +
                                                                                                                                                                                                    +Gets the index of the item that is now selected. -1 if there is no selection. +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + 
                                                                                                                                                                                                    public int SelectedItem { get; }
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + + +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + + +
                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html b/docs/api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html new file mode 100644 index 0000000000..4e0c4a1e5d --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html @@ -0,0 +1,602 @@ + + + + + + + + Class ShortcutHelper + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                    + +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    + +
                                                                                                                                                                                                    +
                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                    +
                                                                                                                                                                                                    +

                                                                                                                                                                                                    +
                                                                                                                                                                                                    +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + + +

                                                                                                                                                                                                      Class ShortcutHelper +

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +Represents a helper to manipulate shortcut keys used on views. +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                      +
                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                      +
                                                                                                                                                                                                      ShortcutHelper
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + System.Object.ToString() +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Namespace: Terminal.Gui
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + 
                                                                                                                                                                                                      public class ShortcutHelper
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +

                                                                                                                                                                                                      Properties +

                                                                                                                                                                                                      + +

                                                                                                                                                                                                      Shortcut

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +This is the global setting that can be used as a global shortcut to invoke the action on the view. +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + 
                                                                                                                                                                                                      public virtual Key Shortcut { get; set; }
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                      Key
                                                                                                                                                                                                      + +

                                                                                                                                                                                                      ShortcutAction

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +The action to run if the Shortcut is defined. +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + 
                                                                                                                                                                                                      public virtual Action ShortcutAction { get; set; }
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                      System.Action
                                                                                                                                                                                                      + +

                                                                                                                                                                                                      ShortcutTag

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +The keystroke combination used in the Shortcut as string. +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + 
                                                                                                                                                                                                      public virtual ustring ShortcutTag { get; }
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                      NStack.ustring
                                                                                                                                                                                                      +

                                                                                                                                                                                                      Methods +

                                                                                                                                                                                                      + +

                                                                                                                                                                                                      CheckKeysFlagRange(Key, Key, Key)

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +Lookup for a Key on range of keys. +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + 
                                                                                                                                                                                                      public static bool CheckKeysFlagRange(Key key, Key first, Key last)
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                      KeykeyThe source key.
                                                                                                                                                                                                      KeyfirstFirst key in range.
                                                                                                                                                                                                      KeylastLast key in range.
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Returns
                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                      System.Boolean
                                                                                                                                                                                                      + +

                                                                                                                                                                                                      FindAndOpenByShortcut(KeyEvent, View)

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +Allows a view to run a ShortcutAction if defined. +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + 
                                                                                                                                                                                                      public static bool FindAndOpenByShortcut(KeyEvent kb, View view = null)
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                      KeyEventkbThe KeyEvent
                                                                                                                                                                                                      ViewviewThe View
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Returns
                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                      System.Booleantrue if defined falseotherwise.
                                                                                                                                                                                                      + +

                                                                                                                                                                                                      GetKeyToString(Key, out Key)

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +Return key as string. +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + 
                                                                                                                                                                                                      public static ustring GetKeyToString(Key key, out Key knm)
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                      KeykeyThe key to extract.
                                                                                                                                                                                                      KeyknmCorrespond to the non modifier key.
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Returns
                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                      NStack.ustring
                                                                                                                                                                                                      + +

                                                                                                                                                                                                      GetModifiersKey(KeyEvent)

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +Gets the key with all the keys modifiers, especially the shift key that sometimes have to be injected later. +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + 
                                                                                                                                                                                                      public static Key GetModifiersKey(KeyEvent kb)
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                      KeyEventkbThe KeyEvent to check.
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Returns
                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                      KeyThe Key with all the keys modifiers.
                                                                                                                                                                                                      + +

                                                                                                                                                                                                      GetShortcutFromTag(ustring, ustring)

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +Allows to retrieve a Key from a ShortcutTag +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + 
                                                                                                                                                                                                      public static Key GetShortcutFromTag(ustring tag, ustring delimiter = null)
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                      NStack.ustringtagThe key as string.
                                                                                                                                                                                                      NStack.ustringdelimiterThe delimiter string.
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Returns
                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                      Key
                                                                                                                                                                                                      + +

                                                                                                                                                                                                      GetShortcutTag(Key, ustring)

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +Get the Shortcut key as string. +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + 
                                                                                                                                                                                                      public static ustring GetShortcutTag(Key shortcut, ustring delimiter = null)
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                      KeyshortcutThe shortcut key.
                                                                                                                                                                                                      NStack.ustringdelimiterThe delimiter string.
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Returns
                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                      NStack.ustring
                                                                                                                                                                                                      + +

                                                                                                                                                                                                      PostShortcutValidation(Key)

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +Used at key up validation. +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + 
                                                                                                                                                                                                      public static bool PostShortcutValidation(Key key)
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                      KeykeyThe key to validate.
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Returns
                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                      System.Booleantrue if is valid.falseotherwise.
                                                                                                                                                                                                      + +

                                                                                                                                                                                                      PreShortcutValidation(Key)

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +Used at key down or key press validation. +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + 
                                                                                                                                                                                                      public static bool PreShortcutValidation(Key key)
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                      KeykeyThe key to validate.
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Returns
                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                      System.Booleantrue if is valid.falseotherwise.
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + + +
                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Size.html b/docs/api/Terminal.Gui/Terminal.Gui.Size.html new file mode 100644 index 0000000000..3e25c229e5 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Size.html @@ -0,0 +1,787 @@ + + + + + + + + Struct Size + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      + +
                                                                                                                                                                                                      +
                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                      +
                                                                                                                                                                                                      +

                                                                                                                                                                                                      +
                                                                                                                                                                                                      +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + +
                                                                                                                                                                                                        + +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + + +

                                                                                                                                                                                                        Struct Size +

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Stores an ordered pair of integers, which specify a Height and Width. +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Namespace: Terminal.Gui
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Assembly: Terminal.Gui.dll
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public struct Size
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +

                                                                                                                                                                                                        Constructors +

                                                                                                                                                                                                        + +

                                                                                                                                                                                                        Size(Int32, Int32)

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Size Constructor +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public Size(int width, int height)
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                        System.Int32width
                                                                                                                                                                                                        System.Int32height
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Creates a Size from specified dimensions. +
                                                                                                                                                                                                        + +

                                                                                                                                                                                                        Size(Point)

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Size Constructor +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public Size(Point pt)
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                        Pointpt
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Creates a Size from a Point value. +
                                                                                                                                                                                                        +

                                                                                                                                                                                                        Fields +

                                                                                                                                                                                                        +

                                                                                                                                                                                                        Empty

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Gets a Size structure that has a Height and Width value of 0. +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public static readonly Size Empty
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                        Size
                                                                                                                                                                                                        +

                                                                                                                                                                                                        Properties +

                                                                                                                                                                                                        + +

                                                                                                                                                                                                        Height

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Height Property +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public int Height { get; set; }
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                        System.Int32
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +The Height coordinate of the Size. +
                                                                                                                                                                                                        + +

                                                                                                                                                                                                        IsEmpty

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +IsEmpty Property +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public readonly bool IsEmpty { get; }
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Indicates if both Width and Height are zero. +
                                                                                                                                                                                                        + +

                                                                                                                                                                                                        Width

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Width Property +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public int Width { get; set; }
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                        System.Int32
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +The Width coordinate of the Size. +
                                                                                                                                                                                                        +

                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                        + +

                                                                                                                                                                                                        Add(Size, Size)

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Adds the width and height of one Size structure to the width and height of another Size structure. +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public static Size Add(Size sz1, Size sz2)
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                        Sizesz1The first Size structure to add.
                                                                                                                                                                                                        Sizesz2The second Size structure to add.
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Returns
                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                        SizeThe add.
                                                                                                                                                                                                        + +

                                                                                                                                                                                                        Equals(Object)

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Equals Method +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public override bool Equals(object obj)
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                        System.Objectobj
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Returns
                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                        +
                                                                                                                                                                                                        System.ValueType.Equals(System.Object)
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Checks equivalence of this Size and another object. +
                                                                                                                                                                                                        + +

                                                                                                                                                                                                        GetHashCode()

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +GetHashCode Method +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public override int GetHashCode()
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Returns
                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                        System.Int32
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                        +
                                                                                                                                                                                                        System.ValueType.GetHashCode()
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Calculates a hashing value. +
                                                                                                                                                                                                        + +

                                                                                                                                                                                                        Subtract(Size, Size)

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Subtracts the width and height of one Size structure to the width and height of another Size structure. +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public static Size Subtract(Size sz1, Size sz2)
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                        Sizesz1The first Size structure to subtract.
                                                                                                                                                                                                        Sizesz2The second Size structure to subtract.
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Returns
                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                        SizeThe subtract.
                                                                                                                                                                                                        + +

                                                                                                                                                                                                        ToString()

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +ToString Method +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public override string ToString()
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Returns
                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                        System.String
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                        +
                                                                                                                                                                                                        System.ValueType.ToString()
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Formats the Size as a string in coordinate notation. +
                                                                                                                                                                                                        +

                                                                                                                                                                                                        Operators +

                                                                                                                                                                                                        + +

                                                                                                                                                                                                        Addition(Size, Size)

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Addition Operator +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public static Size operator +(Size sz1, Size sz2)
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                        Sizesz1
                                                                                                                                                                                                        Sizesz2
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Returns
                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                        Size
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Addition of two Size structures. +
                                                                                                                                                                                                        + +

                                                                                                                                                                                                        Equality(Size, Size)

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Equality Operator +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public static bool operator ==(Size sz1, Size sz2)
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                        Sizesz1
                                                                                                                                                                                                        Sizesz2
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Returns
                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Compares two Size objects. The return value is +based on the equivalence of the Width and Height +properties of the two Sizes. +
                                                                                                                                                                                                        + +

                                                                                                                                                                                                        Explicit(Size to Point)

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Size to Point Conversion +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public static explicit operator Point(Size size)
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                        Sizesize
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Returns
                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                        Point
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Returns a Point based on the dimensions of a given +Size. Requires explicit cast. +
                                                                                                                                                                                                        + +

                                                                                                                                                                                                        Inequality(Size, Size)

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Inequality Operator +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public static bool operator !=(Size sz1, Size sz2)
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                        Sizesz1
                                                                                                                                                                                                        Sizesz2
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Returns
                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Compares two Size objects. The return value is +based on the equivalence of the Width and Height +properties of the two Sizes. +
                                                                                                                                                                                                        + +

                                                                                                                                                                                                        Subtraction(Size, Size)

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Subtraction Operator +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + 
                                                                                                                                                                                                        public static Size operator -(Size sz1, Size sz2)
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                        Sizesz1
                                                                                                                                                                                                        Sizesz2
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Returns
                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                        Size
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +Subtracts two Size structures. +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + + +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + + +
                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.SizeF.html b/docs/api/Terminal.Gui/Terminal.Gui.SizeF.html new file mode 100644 index 0000000000..927626c1c9 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.SizeF.html @@ -0,0 +1,952 @@ + + + + + + + + Struct SizeF + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                        + +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        + +
                                                                                                                                                                                                        +
                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                        +
                                                                                                                                                                                                        +

                                                                                                                                                                                                        +
                                                                                                                                                                                                        +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + + +

                                                                                                                                                                                                          Struct SizeF +

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Represents the size of a rectangular region with an ordered pair of width and height. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Implements
                                                                                                                                                                                                          +
                                                                                                                                                                                                          System.IEquatable<SizeF>
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Namespace: Terminal.Gui
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Assembly: Terminal.Gui.dll
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public struct SizeF : IEquatable<SizeF>
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Constructors +

                                                                                                                                                                                                          + +

                                                                                                                                                                                                          SizeF(Single, Single)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Initializes a new instance of the SizeF class from the specified dimensions. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public SizeF(float width, float height)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          System.Singlewidth
                                                                                                                                                                                                          System.Singleheight
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          SizeF(PointF)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Initializes a new instance of the SizeF class from the specified +PointF. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public SizeF(PointF pt)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          PointFpt
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          SizeF(SizeF)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Initializes a new instance of the SizeF class from the specified +existing SizeF. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public SizeF(SizeF size)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          SizeFsize
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Fields +

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Empty

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Initializes a new instance of the SizeF class. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public static readonly SizeF Empty
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Field Value
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          SizeF
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Properties +

                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Height

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Represents the vertical component of this SizeF. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public float Height { get; set; }
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          System.Single
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          IsEmpty

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Tests whether this SizeF has zero width and height. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          [Browsable(false)]
+public readonly bool IsEmpty { get; }
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Width

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Represents the horizontal component of this SizeF. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public float Width { get; set; }
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          System.Single
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Add(SizeF, SizeF)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Performs vector addition of two SizeF objects. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public static SizeF Add(SizeF sz1, SizeF sz2)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          SizeFsz1
                                                                                                                                                                                                          SizeFsz2
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Returns
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          SizeF
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Equals(Object)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Tests to see whether the specified object is a SizeF with the same dimensions +as this SizeF. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public override bool Equals(object obj)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          System.Objectobj
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Returns
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                          +
                                                                                                                                                                                                          System.ValueType.Equals(System.Object)
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Equals(SizeF)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Tests whether two SizeF objects are identical. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public bool Equals(SizeF other)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          SizeFother
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Returns
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          GetHashCode()

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Generates a hashcode from the width and height +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public override int GetHashCode()
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Returns
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          System.Int32
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                          +
                                                                                                                                                                                                          System.ValueType.GetHashCode()
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Subtract(SizeF, SizeF)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Contracts a SizeF by another SizeF. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public static SizeF Subtract(SizeF sz1, SizeF sz2)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          SizeFsz1
                                                                                                                                                                                                          SizeFsz2
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Returns
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          SizeF
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          ToString()

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Creates a human-readable string that represents this SizeF. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public override string ToString()
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Returns
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          System.String
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                          +
                                                                                                                                                                                                          System.ValueType.ToString()
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Operators +

                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Addition(SizeF, SizeF)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Performs vector addition of two SizeF objects. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public static SizeF operator +(SizeF sz1, SizeF sz2)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          SizeFsz1
                                                                                                                                                                                                          SizeFsz2
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Returns
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          SizeF
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Division(SizeF, Single)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Divides SizeF by a System.Single producing SizeF. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public static SizeF operator /(SizeF left, float right)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          SizeFleftDividend of type SizeF.
                                                                                                                                                                                                          System.SinglerightDivisor of type System.Int32.
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Returns
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          SizeFResult of type SizeF.
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Equality(SizeF, SizeF)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Tests whether two SizeF objects are identical. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public static bool operator ==(SizeF sz1, SizeF sz2)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          SizeFsz1
                                                                                                                                                                                                          SizeFsz2
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Returns
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Explicit(SizeF to PointF)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Converts the specified SizeF to a PointF. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public static explicit operator PointF(SizeF size)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          SizeFsize
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Returns
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          PointF
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Inequality(SizeF, SizeF)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Tests whether two SizeF objects are different. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public static bool operator !=(SizeF sz1, SizeF sz2)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          SizeFsz1
                                                                                                                                                                                                          SizeFsz2
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Returns
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Multiply(Single, SizeF)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Multiplies SizeF by a System.Single producing SizeF. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public static SizeF operator *(float left, SizeF right)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          System.SingleleftMultiplier of type System.Single.
                                                                                                                                                                                                          SizeFrightMultiplicand of type SizeF.
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Returns
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          SizeFProduct of type SizeF.
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Multiply(SizeF, Single)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Multiplies SizeF by a System.Single producing SizeF. +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public static SizeF operator *(SizeF left, float right)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          SizeFleftMultiplicand of type SizeF.
                                                                                                                                                                                                          System.SinglerightMultiplier of type System.Single.
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Returns
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          SizeFProduct of type SizeF.
                                                                                                                                                                                                          + +

                                                                                                                                                                                                          Subtraction(SizeF, SizeF)

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +Contracts a SizeF by another SizeF +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + 
                                                                                                                                                                                                          public static SizeF operator -(SizeF sz1, SizeF sz2)
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                          SizeFsz1
                                                                                                                                                                                                          SizeFsz2
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Returns
                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                          SizeF
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Implements

                                                                                                                                                                                                          +
                                                                                                                                                                                                          + System.IEquatable<T> +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + + +
                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.StackExtensions.html b/docs/api/Terminal.Gui/Terminal.Gui.StackExtensions.html new file mode 100644 index 0000000000..90fdeda520 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.StackExtensions.html @@ -0,0 +1,543 @@ + + + + + + + + Class StackExtensions + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          + +
                                                                                                                                                                                                          +
                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                          +
                                                                                                                                                                                                          +

                                                                                                                                                                                                          +
                                                                                                                                                                                                          +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + +
                                                                                                                                                                                                            + +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + + +

                                                                                                                                                                                                            Class StackExtensions +

                                                                                                                                                                                                            +
                                                                                                                                                                                                            +Extension of System.Collections.Generic.Stack<T> helper to work with specific System.Collections.Generic.IEqualityComparer<T> +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                            +
                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                            +
                                                                                                                                                                                                            StackExtensions
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + System.Object.ToString() +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Namespace: Terminal.Gui
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Assembly: Terminal.Gui.dll
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + 
                                                                                                                                                                                                            public static class StackExtensions
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +

                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                            + +

                                                                                                                                                                                                            Contains<T>(Stack<T>, T, IEqualityComparer<T>)

                                                                                                                                                                                                            +
                                                                                                                                                                                                            +Check if the stack object contains the value to find. +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + 
                                                                                                                                                                                                            public static bool Contains<T>(this Stack<T> stack, T valueToFind, IEqualityComparer<T> comparer = null)
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                            System.Collections.Generic.Stack<T>stackThe stack object.
                                                                                                                                                                                                            TvalueToFindValue to find.
                                                                                                                                                                                                            System.Collections.Generic.IEqualityComparer<T>comparerThe comparison object.
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Returns
                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                            System.Booleantrue If the value was found.false otherwise.
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Type Parameters
                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                            NameDescription
                                                                                                                                                                                                            TThe stack object type.
                                                                                                                                                                                                            + +

                                                                                                                                                                                                            FindDuplicates<T>(Stack<T>, IEqualityComparer<T>)

                                                                                                                                                                                                            +
                                                                                                                                                                                                            +Find all duplicates stack objects values. +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + 
                                                                                                                                                                                                            public static Stack<T> FindDuplicates<T>(this Stack<T> stack, IEqualityComparer<T> comparer = null)
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                            System.Collections.Generic.Stack<T>stackThe stack object.
                                                                                                                                                                                                            System.Collections.Generic.IEqualityComparer<T>comparerThe comparison object.
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Returns
                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                            System.Collections.Generic.Stack<T>The duplicates stack object.
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Type Parameters
                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                            NameDescription
                                                                                                                                                                                                            TThe stack object type.
                                                                                                                                                                                                            + +

                                                                                                                                                                                                            MoveNext<T>(Stack<T>)

                                                                                                                                                                                                            +
                                                                                                                                                                                                            +Move the first stack object value to the end. +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + 
                                                                                                                                                                                                            public static void MoveNext<T>(this Stack<T> stack)
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                            System.Collections.Generic.Stack<T>stackThe stack object.
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Type Parameters
                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                            NameDescription
                                                                                                                                                                                                            TThe stack object type.
                                                                                                                                                                                                            + +

                                                                                                                                                                                                            MovePrevious<T>(Stack<T>)

                                                                                                                                                                                                            +
                                                                                                                                                                                                            +Move the last stack object value to the top. +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + 
                                                                                                                                                                                                            public static void MovePrevious<T>(this Stack<T> stack)
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                            System.Collections.Generic.Stack<T>stackThe stack object.
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Type Parameters
                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                            NameDescription
                                                                                                                                                                                                            TThe stack object type.
                                                                                                                                                                                                            + +

                                                                                                                                                                                                            MoveTo<T>(Stack<T>, T, Int32, IEqualityComparer<T>)

                                                                                                                                                                                                            +
                                                                                                                                                                                                            +Move the stack object value to the index. +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + 
                                                                                                                                                                                                            public static void MoveTo<T>(this Stack<T> stack, T valueToMove, int index = 0, IEqualityComparer<T> comparer = null)
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                            System.Collections.Generic.Stack<T>stackThe stack object.
                                                                                                                                                                                                            TvalueToMoveValue to move.
                                                                                                                                                                                                            System.Int32indexThe index where to move.
                                                                                                                                                                                                            System.Collections.Generic.IEqualityComparer<T>comparerThe comparison object.
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Type Parameters
                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                            NameDescription
                                                                                                                                                                                                            TThe stack object type.
                                                                                                                                                                                                            + +

                                                                                                                                                                                                            Replace<T>(Stack<T>, T, T, IEqualityComparer<T>)

                                                                                                                                                                                                            +
                                                                                                                                                                                                            +Replaces an stack object values that match with the value to replace. +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + 
                                                                                                                                                                                                            public static void Replace<T>(this Stack<T> stack, T valueToReplace, T valueToReplaceWith, IEqualityComparer<T> comparer = null)
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                            System.Collections.Generic.Stack<T>stackThe stack object.
                                                                                                                                                                                                            TvalueToReplaceValue to replace.
                                                                                                                                                                                                            TvalueToReplaceWithValue to replace with to what matches the value to replace.
                                                                                                                                                                                                            System.Collections.Generic.IEqualityComparer<T>comparerThe comparison object.
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Type Parameters
                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                            NameDescription
                                                                                                                                                                                                            TThe stack object type.
                                                                                                                                                                                                            + +

                                                                                                                                                                                                            Swap<T>(Stack<T>, T, T, IEqualityComparer<T>)

                                                                                                                                                                                                            +
                                                                                                                                                                                                            +Swap two stack objects values that matches with the both values. +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + 
                                                                                                                                                                                                            public static void Swap<T>(this Stack<T> stack, T valueToSwapFrom, T valueToSwapTo, IEqualityComparer<T> comparer = null)
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                            System.Collections.Generic.Stack<T>stackThe stack object.
                                                                                                                                                                                                            TvalueToSwapFromValue to swap from.
                                                                                                                                                                                                            TvalueToSwapToValue to swap to.
                                                                                                                                                                                                            System.Collections.Generic.IEqualityComparer<T>comparerThe comparison object.
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Type Parameters
                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                            NameDescription
                                                                                                                                                                                                            TThe stack object type.
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + + +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + + +
                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html b/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html new file mode 100644 index 0000000000..3109e7a382 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html @@ -0,0 +1,928 @@ + + + + + + + + Class StatusBar + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                            + +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            + +
                                                                                                                                                                                                            +
                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                            +
                                                                                                                                                                                                            +

                                                                                                                                                                                                            +
                                                                                                                                                                                                            +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + + +

                                                                                                                                                                                                              Class StatusBar +

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +A status bar is a View that snaps to the bottom of a Toplevel displaying set of StatusItems. +The StatusBar should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will +be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help. +So for each context must be a new instance of a statusbar. +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Inheritance
                                                                                                                                                                                                              +
                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Responder
                                                                                                                                                                                                              +
                                                                                                                                                                                                              View
                                                                                                                                                                                                              +
                                                                                                                                                                                                              StatusBar
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Implements
                                                                                                                                                                                                              +
                                                                                                                                                                                                              System.IDisposable
                                                                                                                                                                                                              +
                                                                                                                                                                                                              System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                              +
                                                                                                                                                                                                              System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                                              + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                              + View.Data +
                                                                                                                                                                                                              + + + + + + +
                                                                                                                                                                                                              + View.Id +
                                                                                                                                                                                                              + + + + + + +
                                                                                                                                                                                                              + View.X +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + View.Y +
                                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                              + View.Text +
                                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Namespace: Terminal.Gui
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + 
                                                                                                                                                                                                              public class StatusBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Constructors +

                                                                                                                                                                                                              + +

                                                                                                                                                                                                              StatusBar()

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +Initializes a new instance of the StatusBar class. +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + 
                                                                                                                                                                                                              public StatusBar()
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +

                                                                                                                                                                                                              StatusBar(StatusItem[])

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +Initializes a new instance of the StatusBar class with the specified set of StatusItems. +The StatusBar will be drawn on the lowest line of the terminal or SuperView (if not null). +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + 
                                                                                                                                                                                                              public StatusBar(StatusItem[] items)
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                              StatusItem[]itemsA list of statusbar items.
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Properties +

                                                                                                                                                                                                              + +

                                                                                                                                                                                                              Items

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +The items that compose the StatusBar +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + 
                                                                                                                                                                                                              public StatusItem[] Items { get; set; }
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                              StatusItem[]
                                                                                                                                                                                                              + +

                                                                                                                                                                                                              ShortcutDelimiter

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +Used for change the shortcut delimiter separator. +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + 
                                                                                                                                                                                                              public static ustring ShortcutDelimiter { get; set; }
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                              NStack.ustring
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Methods +

                                                                                                                                                                                                              + +

                                                                                                                                                                                                              AddItemAt(Int32, StatusItem)

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +Inserts a StatusItem in the specified index of Items. +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + 
                                                                                                                                                                                                              public void AddItemAt(int index, StatusItem item)
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                              System.Int32indexThe zero-based index at which item should be inserted.
                                                                                                                                                                                                              StatusItemitemThe item to insert.
                                                                                                                                                                                                              + +

                                                                                                                                                                                                              Dispose(Boolean)

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + 
                                                                                                                                                                                                              protected override void Dispose(bool disposing)
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                              System.Booleandisposing
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Overrides
                                                                                                                                                                                                              + + +

                                                                                                                                                                                                              MouseEvent(MouseEvent)

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + 
                                                                                                                                                                                                              public override bool MouseEvent(MouseEvent me)
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                              MouseEventme
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Returns
                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                              System.Boolean
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Overrides
                                                                                                                                                                                                              + + +

                                                                                                                                                                                                              OnEnter(View)

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + 
                                                                                                                                                                                                              public override bool OnEnter(View view)
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                              Viewview
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Returns
                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                              System.Boolean
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Overrides
                                                                                                                                                                                                              + + +

                                                                                                                                                                                                              ProcessHotKey(KeyEvent)

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + 
                                                                                                                                                                                                              public override bool ProcessHotKey(KeyEvent kb)
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                              KeyEventkb
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Returns
                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                              System.Boolean
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Overrides
                                                                                                                                                                                                              + + +

                                                                                                                                                                                                              Redraw(Rect)

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + 
                                                                                                                                                                                                              public override void Redraw(Rect bounds)
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                              Rectbounds
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Overrides
                                                                                                                                                                                                              + + +

                                                                                                                                                                                                              RemoveItem(Int32)

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +Removes a StatusItem at specified index of Items. +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + 
                                                                                                                                                                                                              public StatusItem RemoveItem(int index)
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                              System.Int32indexThe zero-based index of the item to remove.
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Returns
                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                              StatusItemThe StatusItem removed.
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Implements

                                                                                                                                                                                                              +
                                                                                                                                                                                                              + System.IDisposable +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + + +
                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.StatusItem.html b/docs/api/Terminal.Gui/Terminal.Gui.StatusItem.html new file mode 100644 index 0000000000..8a9e4e5501 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.StatusItem.html @@ -0,0 +1,285 @@ + + + + + + + + Class StatusItem + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              + +
                                                                                                                                                                                                              +
                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                              +
                                                                                                                                                                                                              +

                                                                                                                                                                                                              +
                                                                                                                                                                                                              +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + +
                                                                                                                                                                                                                + +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                Class StatusItem +

                                                                                                                                                                                                                +
                                                                                                                                                                                                                +StatusItem objects are contained by StatusBar Views. +Each StatusItem has a title, a shortcut (hotkey), and an Action that will be invoked when the +Shortcut is pressed. +The Shortcut will be a global hotkey for the application in the current context of the screen. +The colour of the Title will be changed after each ~. +A Title set to `~F1~ Help` will render as *F1* using HotNormal and +*Help* as HotNormal. +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                +
                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                +
                                                                                                                                                                                                                StatusItem
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + System.Object.ToString() +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Namespace: Terminal.Gui
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + 
                                                                                                                                                                                                                public class StatusItem
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Constructors +

                                                                                                                                                                                                                + +

                                                                                                                                                                                                                StatusItem(Key, ustring, Action)

                                                                                                                                                                                                                +
                                                                                                                                                                                                                +Initializes a new StatusItem. +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + 
                                                                                                                                                                                                                public StatusItem(Key shortcut, ustring title, Action action)
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                KeyshortcutShortcut to activate the StatusItem.
                                                                                                                                                                                                                NStack.ustringtitleTitle for the StatusItem.
                                                                                                                                                                                                                System.ActionactionAction to invoke when the StatusItem is activated.
                                                                                                                                                                                                                +

                                                                                                                                                                                                                Properties +

                                                                                                                                                                                                                + +

                                                                                                                                                                                                                Action

                                                                                                                                                                                                                +
                                                                                                                                                                                                                +Gets or sets the action to be invoked when the statusbar item is triggered +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + 
                                                                                                                                                                                                                public Action Action { get; }
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                System.ActionAction to invoke.
                                                                                                                                                                                                                + +

                                                                                                                                                                                                                Shortcut

                                                                                                                                                                                                                +
                                                                                                                                                                                                                +Gets the global shortcut to invoke the action on the menu. +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + 
                                                                                                                                                                                                                public Key Shortcut { get; }
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                Key
                                                                                                                                                                                                                + +

                                                                                                                                                                                                                Title

                                                                                                                                                                                                                +
                                                                                                                                                                                                                +Gets or sets the title. +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + 
                                                                                                                                                                                                                public ustring Title { get; set; }
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                NStack.ustringThe title.
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Remarks
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +The colour of the Title will be changed after each ~. +A Title set to `~F1~ Help` will render as *F1* using HotNormal and +*Help* as HotNormal. +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TabView.Tab.html b/docs/api/Terminal.Gui/Terminal.Gui.TabView.Tab.html new file mode 100644 index 0000000000..33bd4a85d4 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TabView.Tab.html @@ -0,0 +1,253 @@ + + + + + + + + Class TabView.Tab + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                + +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                + +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                +
                                                                                                                                                                                                                +

                                                                                                                                                                                                                +
                                                                                                                                                                                                                +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                  Class TabView.Tab +

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +A single tab in a TabView +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  TabView.Tab
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + System.Object.ToString() +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Namespace: Terminal.Gui
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                  public class Tab
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Constructors +

                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                  Tab()

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +Creates a new unamed tab with no controls inside +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                  public Tab()
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                  Tab(String, View)

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +Creates a new tab with the given text hosting a view +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                  public Tab(string text, View view)
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                                  System.Stringtext
                                                                                                                                                                                                                  Viewview
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  Properties +

                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                  Text

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +The text to display in a TabView +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                  public ustring Text { get; set; }
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                  NStack.ustring
                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                  View

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +The control to display when the tab is selected +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                  public View View { get; set; }
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                  View
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TabView.TabChangedEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.TabView.TabChangedEventArgs.html new file mode 100644 index 0000000000..2cb01da0eb --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TabView.TabChangedEventArgs.html @@ -0,0 +1,247 @@ + + + + + + + + Class TabView.TabChangedEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                    Class TabView.TabChangedEventArgs +

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +Describes a change in SelectedTab +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    System.EventArgs
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    TabView.TabChangedEventArgs
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + System.EventArgs.Empty +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + System.Object.ToString() +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    Namespace: Terminal.Gui
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                    public class TabChangedEventArgs : EventArgs
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Constructors +

                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                    TabChangedEventArgs(TabView.Tab, TabView.Tab)

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +Documents a tab change +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                    public TabChangedEventArgs(TabView.Tab oldTab, TabView.Tab newTab)
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                    TabView.TaboldTab
                                                                                                                                                                                                                    TabView.TabnewTab
                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    Properties +

                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                    NewTab

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +The currently selected tab. May be null +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                    public TabView.Tab NewTab { get; }
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                    TabView.Tab
                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                    OldTab

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +The previously selected tab. May be null +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                    public TabView.Tab OldTab { get; }
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                    TabView.Tab
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TabView.TabStyle.html b/docs/api/Terminal.Gui/Terminal.Gui.TabView.TabStyle.html new file mode 100644 index 0000000000..683e1c9375 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TabView.TabStyle.html @@ -0,0 +1,239 @@ + + + + + + + + Class TabView.TabStyle + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +

                                                                                                                                                                                                                    +
                                                                                                                                                                                                                    +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                      Class TabView.TabStyle +

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +Describes render stylistic selections of a TabView +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      TabView.TabStyle
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + System.Object.ToString() +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Namespace: Terminal.Gui
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                      public class TabStyle
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      Properties +

                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                      ShowBorder

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +True to show a solid box around the edge of the control. Defaults to true. +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                      public bool ShowBorder { get; set; }
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                      System.Boolean
                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                      ShowTopLine

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +True to show the top lip of tabs. False to directly begin with tab text during +rendering. When true header line occupies 3 rows, when false only 2. +Defaults to true. + +

                                                                                                                                                                                                                      When TabsOnBottom is enabled this instead applies to the + bottommost line of the control

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                      public bool ShowTopLine { get; set; }
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                      System.Boolean
                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                      TabsOnBottom

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +True to render tabs at the bottom of the view instead of the top +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                      public bool TabsOnBottom { get; set; }
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                      System.Boolean
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TabView.html b/docs/api/Terminal.Gui/Terminal.Gui.TabView.html new file mode 100644 index 0000000000..89de8e1c0f --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TabView.html @@ -0,0 +1,1033 @@ + + + + + + + + Class TabView + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                        Class TabView +

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +Control that hosts multiple sub views, presenting a single one at once +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Responder
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        View
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        TabView
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Implements
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        System.IDisposable
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                        + View.Data +
                                                                                                                                                                                                                        + + + + + + +
                                                                                                                                                                                                                        + View.Id +
                                                                                                                                                                                                                        + + + + + + +
                                                                                                                                                                                                                        + View.X +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + View.Y +
                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                        + View.Text +
                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Namespace: Terminal.Gui
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public class TabView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Constructors +

                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        TabView()

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +Initialzies a TabView class using Computed layout. +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public TabView()
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Fields +

                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        DefaultMaxTabTextWidth

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +The default MaxTabTextWidth to set on new TabView controls +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public const uint DefaultMaxTabTextWidth = 30U
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                        System.UInt32
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Properties +

                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        MaxTabTextWidth

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +The maximum number of characters to render in a Tab header. This prevents one long tab +from pushing out all the others. +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public uint MaxTabTextWidth { get; set; }
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                        System.UInt32
                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        SelectedTab

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +The currently selected member of Tabs chosen by the user +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public TabView.Tab SelectedTab { get; set; }
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                        TabView.Tab
                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        Style

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +Render choices for how to display tabs. After making changes, call ApplyStyleChanges() +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public TabView.TabStyle Style { get; set; }
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                        TabView.TabStyle
                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        Tabs

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +All tabs currently hosted by the control +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public IReadOnlyCollection<TabView.Tab> Tabs { get; }
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                        System.Collections.Generic.IReadOnlyCollection<TabView.Tab>
                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        TabScrollOffset

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +When there are too many tabs to render, this indicates the first +tab to render on the screen. +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public int TabScrollOffset { get; set; }
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                        System.Int32
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        AddTab(TabView.Tab, Boolean)

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +Adds the given tab to Tabs +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public void AddTab(TabView.Tab tab, bool andSelect)
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                        TabView.Tabtab
                                                                                                                                                                                                                        System.BooleanandSelectTrue to make the newly added Tab the SelectedTab
                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        ApplyStyleChanges()

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +Updates the control to use the latest state settings in Style. +This can change the size of the client area of the tab (for rendering the +selected tab's content). This method includes a call +to SetNeedsDisplay() +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public void ApplyStyleChanges()
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        Dispose(Boolean)

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +Disposes the control and all Tabs +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        protected override void Dispose(bool disposing)
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                        System.Booleandisposing
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                        EnsureSelectedTabIsVisible()

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +Updates TabScrollOffset to ensure that SelectedTab is visible +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public void EnsureSelectedTabIsVisible()
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        EnsureValidScrollOffsets()

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +Updates TabScrollOffset to be a valid index of Tabs +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public void EnsureValidScrollOffsets()
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Changes will not be immediately visible in the display until you call SetNeedsDisplay()
                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        OnSelectedTabChanged(TabView.Tab, TabView.Tab)

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +Raises the SelectedTabChanged event +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        protected virtual void OnSelectedTabChanged(TabView.Tab oldTab, TabView.Tab newTab)
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                        TabView.TaboldTab
                                                                                                                                                                                                                        TabView.TabnewTab
                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        ProcessKey(KeyEvent)

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public override bool ProcessKey(KeyEvent keyEvent)
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                        KeyEventkeyEvent
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                        Redraw(Rect)

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public override void Redraw(Rect bounds)
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                        Rectbounds
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                        RemoveTab(TabView.Tab)

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +Removes the given tab from Tabs. +Caller is responsible for disposing the tab's hosted View +if appropriate. +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public void RemoveTab(TabView.Tab tab)
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                        TabView.Tabtab
                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        SwitchTabBy(Int32)

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +Changes the SelectedTab by the given amount. +Positive for right, negative for left. If no tab is currently selected then +the first tab will become selected +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public void SwitchTabBy(int amount)
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                        System.Int32amount
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Events +

                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        SelectedTabChanged

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +Event for when SelectedTab changes +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                        public event EventHandler<TabView.TabChangedEventArgs> SelectedTabChanged
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                        System.EventHandler<TabView.TabChangedEventArgs>
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + System.IDisposable +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.CellActivatedEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.CellActivatedEventArgs.html new file mode 100644 index 0000000000..8597d90c5b --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.CellActivatedEventArgs.html @@ -0,0 +1,277 @@ + + + + + + + + Class TableView.CellActivatedEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                          Class TableView.CellActivatedEventArgs +

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +Defines the event arguments for CellActivated event +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          System.EventArgs
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          TableView.CellActivatedEventArgs
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + System.EventArgs.Empty +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + System.Object.ToString() +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Namespace: Terminal.Gui
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                          public class CellActivatedEventArgs : EventArgs
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Constructors +

                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                          CellActivatedEventArgs(DataTable, Int32, Int32)

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +Creates a new instance of arguments describing a cell being activated in TableView +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                          public CellActivatedEventArgs(DataTable t, int col, int row)
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                          System.Data.DataTablet
                                                                                                                                                                                                                          System.Int32col
                                                                                                                                                                                                                          System.Int32row
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Properties +

                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                          Col

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +The column index of the Table cell that is being activated +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                          public int Col { get; }
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                          System.Int32
                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                          Row

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +The row index of the Table cell that is being activated +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                          public int Row { get; }
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                          System.Int32
                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                          Table

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +The current table to which the new indexes refer. May be null e.g. if selection change is the result of clearing the table from the view +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                          public DataTable Table { get; }
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                          System.Data.DataTable
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterArgs.html new file mode 100644 index 0000000000..1153f20209 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterArgs.html @@ -0,0 +1,310 @@ + + + + + + + + Class TableView.CellColorGetterArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                            Class TableView.CellColorGetterArgs +

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +Arguments for a TableView.CellColorGetterDelegate. Describes a cell for which a rendering +ColorScheme is being sought +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            TableView.CellColorGetterArgs
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + System.Object.ToString() +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Namespace: Terminal.Gui
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                            public class CellColorGetterArgs
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Properties +

                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                            CellValue

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +The hard typed value being rendered in the cell for which color is needed +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                            public object CellValue { get; }
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                            ColIdex

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +The index of column in Table for which color is needed +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                            public int ColIdex { get; }
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                            System.Int32
                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                            Representation

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +The textual representation of CellValue (what will actually be drawn to the screen) +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                            public string Representation { get; }
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                            System.String
                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                            RowIndex

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +The index of the row in Table for which color is needed +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                            public int RowIndex { get; }
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                            System.Int32
                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                            RowScheme

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +the color scheme that is going to be used to render the cell if no cell specific color scheme is returned +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                            public ColorScheme RowScheme { get; }
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                            ColorScheme
                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                            Table

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +The data table hosted by the TableView control. +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                            public DataTable Table { get; }
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                            System.Data.DataTable
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterDelegate.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterDelegate.html new file mode 100644 index 0000000000..7e4a6da2d1 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterDelegate.html @@ -0,0 +1,160 @@ + + + + + + + + Delegate TableView.CellColorGetterDelegate + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                              Delegate TableView.CellColorGetterDelegate +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +Delegate for providing color to TableView cells based on the value being rendered +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Namespace: Terminal.Gui
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                              public delegate ColorScheme CellColorGetterDelegate(TableView.CellColorGetterArgs args);
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                              TableView.CellColorGetterArgsargsContains information about the cell for which color is needed
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                              ColorScheme
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.ColumnStyle.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.ColumnStyle.html new file mode 100644 index 0000000000..89c0f0e35e --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.ColumnStyle.html @@ -0,0 +1,457 @@ + + + + + + + + Class TableView.ColumnStyle + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                Class TableView.ColumnStyle +

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +Describes how to render a given column in a TableView including Alignment +and textual representation of cells (e.g. date formats) + +See TableView Deep Dive for more information. +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                TableView.ColumnStyle
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + System.Object.ToString() +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Namespace: Terminal.Gui
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                public class ColumnStyle
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Fields +

                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                AlignmentGetter

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +Defines a delegate for returning custom alignment per cell based on cell values. When specified this will override Alignment +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                public Func<object, TextAlignment> AlignmentGetter
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                System.Func<System.Object, TextAlignment>
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                ColorGetter

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +Defines a delegate for returning a custom color scheme per cell based on cell values. +Return null for the default +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                public TableView.CellColorGetterDelegate ColorGetter
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                TableView.CellColorGetterDelegate
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                RepresentationGetter

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +Defines a delegate for returning custom representations of cell values. If not set then System.Object.ToString() is used. Return values from your delegate may be truncated e.g. based on MaxWidth +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                public Func<object, string> RepresentationGetter
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                System.Func<System.Object, System.String>
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Properties +

                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                Alignment

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +Defines the default alignment for all values rendered in this column. For custom alignment based on cell contents use AlignmentGetter. +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                public TextAlignment Alignment { get; set; }
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                TextAlignment
                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                Format

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +Defines the format for values e.g. "yyyy-MM-dd" for dates +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                public string Format { get; set; }
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                System.String
                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                MaxWidth

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +Set the maximum width of the column in characters. This value will be ignored if more than the tables MaxCellWidth. Defaults to DefaultMaxCellWidth +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                public int MaxWidth { get; set; }
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                MinAcceptableWidth

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +Enables flexible sizing of this column based on available screen space to render into. +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                public int MinAcceptableWidth { get; set; }
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                MinWidth

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +Set the minimum width of the column in characters. Setting this will ensure that +even when a column has short content/header it still fills a given width of the control. + +

                                                                                                                                                                                                                                This value will be ignored if more than the tables MaxCellWidth +or the MaxWidth +

                                                                                                                                                                                                                                + +For setting a flexible column width (down to a lower limit) use MinAcceptableWidth +instead + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                public int MinWidth { get; set; }
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Methods +

                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                GetAlignment(Object)

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +Returns the alignment for the cell based on cellValue and AlignmentGetter/Alignment +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                public TextAlignment GetAlignment(object cellValue)
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                System.ObjectcellValue
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                TextAlignment
                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                GetRepresentation(Object)

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +Returns the full string to render (which may be truncated if too long) that the current style says best represents the given value +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                public string GetRepresentation(object value)
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                System.Objectvalue
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                System.String
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterArgs.html new file mode 100644 index 0000000000..96a587a6f0 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterArgs.html @@ -0,0 +1,210 @@ + + + + + + + + Class TableView.RowColorGetterArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                  Class TableView.RowColorGetterArgs +

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +Arguments for TableView.RowColorGetterDelegate. Describes a row of data in a System.Data.DataTable +for which ColorScheme is sought. +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  TableView.RowColorGetterArgs
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + System.Object.ToString() +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Namespace: Terminal.Gui
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                  public class RowColorGetterArgs
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Properties +

                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                  RowIndex

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +The index of the row in Table for which color is needed +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                  public int RowIndex { get; }
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                  System.Int32
                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                  Table

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +The data table hosted by the TableView control. +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                  public DataTable Table { get; }
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                  System.Data.DataTable
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterDelegate.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterDelegate.html new file mode 100644 index 0000000000..404fa31967 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterDelegate.html @@ -0,0 +1,160 @@ + + + + + + + + Delegate TableView.RowColorGetterDelegate + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                    Delegate TableView.RowColorGetterDelegate +

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +Delegate for providing color for a whole row of a TableView +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    Namespace: Terminal.Gui
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                    public delegate ColorScheme RowColorGetterDelegate(TableView.RowColorGetterArgs args);
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                    TableView.RowColorGetterArgsargs
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                    ColorScheme
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.SelectedCellChangedEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.SelectedCellChangedEventArgs.html new file mode 100644 index 0000000000..03f4f0d0a5 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.SelectedCellChangedEventArgs.html @@ -0,0 +1,337 @@ + + + + + + + + Class TableView.SelectedCellChangedEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                      Class TableView.SelectedCellChangedEventArgs +

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +Defines the event arguments for SelectedCellChanged +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      System.EventArgs
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      TableView.SelectedCellChangedEventArgs
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + System.EventArgs.Empty +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + System.Object.ToString() +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Namespace: Terminal.Gui
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                      public class SelectedCellChangedEventArgs : EventArgs
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Constructors +

                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                      SelectedCellChangedEventArgs(DataTable, Int32, Int32, Int32, Int32)

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +Creates a new instance of arguments describing a change in selected cell in a TableView +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                      public SelectedCellChangedEventArgs(DataTable t, int oldCol, int newCol, int oldRow, int newRow)
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                      System.Data.DataTablet
                                                                                                                                                                                                                                      System.Int32oldCol
                                                                                                                                                                                                                                      System.Int32newCol
                                                                                                                                                                                                                                      System.Int32oldRow
                                                                                                                                                                                                                                      System.Int32newRow
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Properties +

                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                      NewCol

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +The newly selected column index. +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                      public int NewCol { get; }
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                      System.Int32
                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                      NewRow

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +The newly selected row index. +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                      public int NewRow { get; }
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                      System.Int32
                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                      OldCol

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +The previous selected column index. May be invalid e.g. when the selection has been changed as a result of replacing the existing Table with a smaller one +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                      public int OldCol { get; }
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                      System.Int32
                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                      OldRow

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +The previous selected row index. May be invalid e.g. when the selection has been changed as a result of deleting rows from the table +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                      public int OldRow { get; }
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                      System.Int32
                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                      Table

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +The current table to which the new indexes refer. May be null e.g. if selection change is the result of clearing the table from the view +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                      public DataTable Table { get; }
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                      System.Data.DataTable
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableSelection.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableSelection.html new file mode 100644 index 0000000000..c01c97cf68 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableSelection.html @@ -0,0 +1,243 @@ + + + + + + + + Class TableView.TableSelection + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                        Class TableView.TableSelection +

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +Describes a selected region of the table +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        TableView.TableSelection
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + System.Object.ToString() +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        Namespace: Terminal.Gui
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                        public class TableSelection
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Constructors +

                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                        TableSelection(Point, Rect)

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +Creates a new selected area starting at the origin corner and covering the provided rectangular area +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                        public TableSelection(Point origin, Rect rect)
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                        Pointorigin
                                                                                                                                                                                                                                        Rectrect
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Properties +

                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                        Origin

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +Corner of the Rect where selection began +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                        public Point Origin { get; set; }
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                        Point
                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                        Rect

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +Area selected +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                        public Rect Rect { get; set; }
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                        Rect
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableStyle.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableStyle.html new file mode 100644 index 0000000000..fdb9b1f67d --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableStyle.html @@ -0,0 +1,542 @@ + + + + + + + + Class TableView.TableStyle + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                          Class TableView.TableStyle +

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +Defines rendering options that affect how the table is displayed. + +See TableView Deep Dive for more information. +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          TableView.TableStyle
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + System.Object.ToString() +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Namespace: Terminal.Gui
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                          public class TableStyle
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Properties +

                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          AlwaysShowHeaders

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +When scrolling down always lock the column headers in place as the first row of the table +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                          public bool AlwaysShowHeaders { get; set; }
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          ColumnStyles

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +Collection of columns for which you want special rendering (e.g. custom column lengths, text alignment etc) +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                          public Dictionary<DataColumn, TableView.ColumnStyle> ColumnStyles { get; set; }
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                          System.Collections.Generic.Dictionary<System.Data.DataColumn, TableView.ColumnStyle>
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          ExpandLastColumn

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +Determines rendering when the last column in the table is visible but it's +content or MaxWidth is less than the remaining +space in the control. True (the default) will expand the column to fill +the remaining bounds of the control. False will draw a column ending line +and leave a blank column that cannot be selected in the remaining space. +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                          public bool ExpandLastColumn { get; set; }
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          InvertSelectedCellFirstCharacter

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +True to invert the colors of the first symbol of the selected cell in the TableView. +This gives the appearance of a cursor for when the ConsoleDriver doesn't otherwise show +this +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                          public bool InvertSelectedCellFirstCharacter { get; set; }
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          RowColorGetter

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +Delegate for coloring specific rows in a different color. For cell color ColorGetter +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                          public TableView.RowColorGetterDelegate RowColorGetter { get; set; }
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                          TableView.RowColorGetterDelegate
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          ShowHorizontalHeaderOverline

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +True to render a solid line above the headers +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                          public bool ShowHorizontalHeaderOverline { get; set; }
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          ShowHorizontalHeaderUnderline

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +True to render a solid line under the headers +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                          public bool ShowHorizontalHeaderUnderline { get; set; }
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          ShowHorizontalScrollIndicators

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +True to render a arrows on the right/left of the table when +there are more column(s) that can be scrolled to. Requires +ShowHorizontalHeaderUnderline to be true. +Defaults to true +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                          public bool ShowHorizontalScrollIndicators { get; set; }
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          ShowVerticalCellLines

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +True to render a solid line vertical line between cells +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                          public bool ShowVerticalCellLines { get; set; }
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          ShowVerticalHeaderLines

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +True to render a solid line vertical line between headers +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                          public bool ShowVerticalHeaderLines { get; set; }
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          SmoothHorizontalScrolling

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          +Determines how ColumnOffset is updated when scrolling +right off the end of the currently visible area. +

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          +If true then when scrolling right the scroll offset is increased the minimum required to show +the new column. This may be slow if you have an incredibly large number of columns in +your table and/or slow RepresentationGetter implementations +

                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          +If false then scroll offset is set to the currently selected column (i.e. PageRight). +

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                          public bool SmoothHorizontalScrolling { get; set; }
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          GetColumnStyleIfAny(DataColumn)

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +Returns the entry from ColumnStyles for the given col or null if no custom styling is defined for it +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                          public TableView.ColumnStyle GetColumnStyleIfAny(DataColumn col)
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                          System.Data.DataColumncol
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                          TableView.ColumnStyle
                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                          GetOrCreateColumnStyle(DataColumn)

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +Returns an existing TableView.ColumnStyle for the given col or creates a new one with default options +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                          public TableView.ColumnStyle GetOrCreateColumnStyle(DataColumn col)
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                          System.Data.DataColumncol
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                          TableView.ColumnStyle
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.html new file mode 100644 index 0000000000..ba1996b39a --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.html @@ -0,0 +1,1730 @@ + + + + + + + + Class TableView + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                            Class TableView +

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +View for tabular data based on a System.Data.DataTable. + +See TableView Deep Dive for more information. +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Responder
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            View
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            TableView
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Implements
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            System.IDisposable
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            + View.Data +
                                                                                                                                                                                                                                            + + + + + + +
                                                                                                                                                                                                                                            + View.Id +
                                                                                                                                                                                                                                            + + + + + + +
                                                                                                                                                                                                                                            + View.X +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + View.Y +
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            + View.Text +
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Namespace: Terminal.Gui
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public class TableView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            Constructors +

                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            TableView()

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Initialzies a TableView class using Computed layout. Set the Table property to begin editing +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public TableView()
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            TableView(DataTable)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Initialzies a TableView class using Computed layout. +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public TableView(DataTable table)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            System.Data.DataTabletableThe table to display in the control
                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            Fields +

                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            DefaultMaxCellWidth

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +The default maximum cell width for MaxCellWidth and MaxWidth +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public const int DefaultMaxCellWidth = 100
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Field Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Int32
                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            DefaultMinAcceptableWidth

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +The default minimum cell width for MinAcceptableWidth +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public const int DefaultMinAcceptableWidth = 100
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Field Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Int32
                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            Properties +

                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            CellActivationKey

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +The key which when pressed should trigger CellActivated event. Defaults to Enter. +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public Key CellActivationKey { get; set; }
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            Key
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            ColumnOffset

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Horizontal scroll offset. The index of the first column in Table to display when when rendering the view. +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public int ColumnOffset { get; set; }
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Int32
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Remarks
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            This property allows very wide tables to be rendered with horizontal scrolling
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            FullRowSelect

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +True to select the entire row at once. False to select individual cells. Defaults to false +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public bool FullRowSelect { get; set; }
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            MaxCellWidth

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +The maximum number of characters to render in any given column. This prevents one long column from pushing out all the others +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public int MaxCellWidth { get; set; }
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Int32
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            MultiSelect

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +True to allow regions to be selected +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public bool MultiSelect { get; set; }
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            MultiSelectedRegions

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +When MultiSelect is enabled this property contain all rectangles of selected cells. Rectangles describe column/rows selected in Table (not screen coordinates) +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public Stack<TableView.TableSelection> MultiSelectedRegions { get; }
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Collections.Generic.Stack<TableView.TableSelection>
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            NullSymbol

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +The text representation that should be rendered for cells with the value System.DBNull.Value +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public string NullSymbol { get; set; }
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.String
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            RowOffset

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Vertical scroll offset. The index of the first row in Table to display in the first non header line of the control when rendering the view. +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public int RowOffset { get; set; }
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Int32
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            SelectedColumn

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +The index of System.Data.DataTable.Columns in Table that the user has currently selected +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public int SelectedColumn { get; set; }
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Int32
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            SelectedRow

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +The index of System.Data.DataTable.Rows in Table that the user has currently selected +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public int SelectedRow { get; set; }
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Int32
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            SeparatorSymbol

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +The symbol to add after each cell value and header value to visually seperate values (if not using vertical gridlines) +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public char SeparatorSymbol { get; set; }
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Char
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            Style

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Contains options for changing how the table is rendered +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public TableView.TableStyle Style { get; set; }
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            TableView.TableStyle
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            Table

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +The data table to render in the view. Setting this property automatically updates and redraws the control. +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public DataTable Table { get; set; }
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Data.DataTable
                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            CellToScreen(Int32, Int32)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Returns the screen position (relative to the control client area) that the given cell is rendered or null if it is outside the current scroll area or no table is loaded +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public Point? CellToScreen(int tableColumn, int tableRow)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            System.Int32tableColumnThe index of the Table column you are looking for, use System.Data.DataColumn.Ordinal
                                                                                                                                                                                                                                            System.Int32tableRowThe index of the row in Table that you are looking for
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Nullable<Point>
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            ChangeSelectionByOffset(Int32, Int32, Boolean)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Moves the SelectedRow and SelectedColumn by the provided offsets. Optionally starting a box selection (see MultiSelect) +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public void ChangeSelectionByOffset(int offsetX, int offsetY, bool extendExistingSelection)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            System.Int32offsetXOffset in number of columns
                                                                                                                                                                                                                                            System.Int32offsetYOffset in number of rows
                                                                                                                                                                                                                                            System.BooleanextendExistingSelectionTrue to create a multi cell selection or adjust an existing one
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            ChangeSelectionToEndOfRow(Boolean)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Moves or extends the selection to the last cell in the current row +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public void ChangeSelectionToEndOfRow(bool extend)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            System.Booleanextendtrue to extend the current selection (if any) instead of replacing
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            ChangeSelectionToEndOfTable(Boolean)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Moves or extends the selection to the final cell in the table +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public void ChangeSelectionToEndOfTable(bool extend)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            System.Booleanextendtrue to extend the current selection (if any) instead of replacing
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            ChangeSelectionToStartOfRow(Boolean)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Moves or extends the selection to the first cell in the current row +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public void ChangeSelectionToStartOfRow(bool extend)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            System.Booleanextendtrue to extend the current selection (if any) instead of replacing
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            ChangeSelectionToStartOfTable(Boolean)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Moves or extends the selection to the first cell in the table (0,0) +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public void ChangeSelectionToStartOfTable(bool extend)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            System.Booleanextendtrue to extend the current selection (if any) instead of replacing
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            EnsureSelectedCellIsVisible()

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Updates scroll offsets to ensure that the selected cell is visible. Has no effect if Table has not been set. +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public void EnsureSelectedCellIsVisible()
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Remarks
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Changes will not be immediately visible in the display until you call SetNeedsDisplay()
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            EnsureValidScrollOffsets()

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Updates ColumnOffset and RowOffset where they are outside the bounds of the table (by adjusting them to the nearest existing cell). Has no effect if Table has not been set. +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public void EnsureValidScrollOffsets()
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Remarks
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Changes will not be immediately visible in the display until you call SetNeedsDisplay()
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            EnsureValidSelection()

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Updates SelectedColumn, SelectedRow and MultiSelectedRegions where they are outside the bounds of the table (by adjusting them to the nearest existing cell). Has no effect if Table has not been set. +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public void EnsureValidSelection()
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Remarks
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Changes will not be immediately visible in the display until you call SetNeedsDisplay()
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            GetAllSelectedCells()

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Returns all cells in any MultiSelectedRegions (if MultiSelect is enabled) and the selected cell +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public IEnumerable<Point> GetAllSelectedCells()
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Collections.Generic.IEnumerable<Point>
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            IsSelected(Int32, Int32)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Returns true if the given cell is selected either because it is the active cell or part of a multi cell selection (e.g. FullRowSelect) +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public bool IsSelected(int col, int row)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            System.Int32col
                                                                                                                                                                                                                                            System.Int32row
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            MouseEvent(MouseEvent)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public override bool MouseEvent(MouseEvent me)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            MouseEventme
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                            OnCellActivated(TableView.CellActivatedEventArgs)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Invokes the CellActivated event +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            protected virtual void OnCellActivated(TableView.CellActivatedEventArgs args)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            TableView.CellActivatedEventArgsargs
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            OnSelectedCellChanged(TableView.SelectedCellChangedEventArgs)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Invokes the SelectedCellChanged event +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            protected virtual void OnSelectedCellChanged(TableView.SelectedCellChangedEventArgs args)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            TableView.SelectedCellChangedEventArgsargs
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            PageDown(Boolean)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Moves the selection down by one page +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public void PageDown(bool extend)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            System.Booleanextendtrue to extend the current selection (if any) instead of replacing
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            PageUp(Boolean)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Moves the selection up by one page +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public void PageUp(bool extend)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            System.Booleanextendtrue to extend the current selection (if any) instead of replacing
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            PositionCursor()

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Positions the cursor in the area of the screen in which the start of the active cell is rendered. Calls base implementation if active cell is not visible due to scrolling or table is loaded etc +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public override void PositionCursor()
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                            ProcessKey(KeyEvent)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public override bool ProcessKey(KeyEvent keyEvent)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            KeyEventkeyEvent
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                            Redraw(Rect)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public override void Redraw(Rect bounds)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            Rectbounds
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                            RenderCell(Attribute, String, Boolean)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Override to provide custom multi colouring to cells. Use Driver to +with AddStr(ustring). The driver will already be +in the correct place when rendering and you must render the full render +or the view will not look right. For simpler provision of color use ColorGetter +For changing the content that is rendered use RepresentationGetter +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            protected virtual void RenderCell(Attribute cellColor, string render, bool isPrimaryCell)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            AttributecellColor
                                                                                                                                                                                                                                            System.Stringrender
                                                                                                                                                                                                                                            System.BooleanisPrimaryCell
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            ScreenToCell(Int32, Int32)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Returns the column and row of Table that corresponds to a given point on the screen (relative to the control client area). Returns null if the point is in the header, no table is loaded or outside the control bounds +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public Point? ScreenToCell(int clientX, int clientY)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            System.Int32clientXX offset from the top left of the control
                                                                                                                                                                                                                                            System.Int32clientYY offset from the top left of the control
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Nullable<Point>
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            SelectAll()

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +When MultiSelect is on, creates selection over all cells in the table (replacing any old selection regions) +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public void SelectAll()
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            SetSelection(Int32, Int32, Boolean)

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Moves the SelectedRow and SelectedColumn to the given col/row in Table. Optionally starting a box selection (see MultiSelect) +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public void SetSelection(int col, int row, bool extendExistingSelection)
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                            System.Int32col
                                                                                                                                                                                                                                            System.Int32row
                                                                                                                                                                                                                                            System.BooleanextendExistingSelectionTrue to create a multi cell selection or adjust an existing one
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            Update()

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +Updates the view to reflect changes to Table and to (ColumnOffset / RowOffset) etc +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public void Update()
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Remarks
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            This always calls SetNeedsDisplay()
                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            Events +

                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            CellActivated

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +This event is raised when a cell is activated e.g. by double clicking or pressing CellActivationKey +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public event Action<TableView.CellActivatedEventArgs> CellActivated
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Action<TableView.CellActivatedEventArgs>
                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            SelectedCellChanged

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +This event is raised when the selected cell in the table changes. +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                            public event Action<TableView.SelectedCellChangedEventArgs> SelectedCellChanged
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                            System.Action<TableView.SelectedCellChangedEventArgs>
                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + System.IDisposable +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextAlignment.html b/docs/api/Terminal.Gui/Terminal.Gui.TextAlignment.html new file mode 100644 index 0000000000..1275e465c3 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextAlignment.html @@ -0,0 +1,164 @@ + + + + + + + + Enum TextAlignment + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                              Enum TextAlignment +

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +Text alignment enumeration, controls how text is displayed. +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Namespace: Terminal.Gui
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                              public enum TextAlignment
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Fields +

                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                              NameDescription
                                                                                                                                                                                                                                              Centered +Centers the text in the frame. +
                                                                                                                                                                                                                                              Justified +Shows the text as justified text in the frame. +
                                                                                                                                                                                                                                              Left +Aligns the text to the left of the frame. +
                                                                                                                                                                                                                                              Right +Aligns the text to the right side of the frame. +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html new file mode 100644 index 0000000000..ca7548741b --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html @@ -0,0 +1,242 @@ + + + + + + + + Class TextChangingEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                Class TextChangingEventArgs +

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +An System.EventArgs which allows passing a cancelable new text value event. +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                System.EventArgs
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                TextChangingEventArgs
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + System.EventArgs.Empty +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + System.Object.ToString() +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                Namespace: Terminal.Gui
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                public class TextChangingEventArgs : EventArgs
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Constructors +

                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                TextChangingEventArgs(ustring)

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +Initializes a new instance of TextChangingEventArgs +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                public TextChangingEventArgs(ustring newText)
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                NStack.ustringnewTextThe new Text to be replaced.
                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Properties +

                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                Cancel

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +Flag which allows to cancel the new text value. +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                public bool Cancel { get; set; }
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                NewText

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +The new text to be replaced. +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                public ustring NewText { get; set; }
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                NStack.ustring
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextDirection.html b/docs/api/Terminal.Gui/Terminal.Gui.TextDirection.html new file mode 100644 index 0000000000..56b1da0391 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextDirection.html @@ -0,0 +1,196 @@ + + + + + + + + Enum TextDirection + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                  Enum TextDirection +

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +Text direction enumeration, controls how text is displayed. +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Namespace: Terminal.Gui
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                  public enum TextDirection
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Fields +

                                                                                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                  NameDescription
                                                                                                                                                                                                                                                  BottomTop_LeftRight +This is a vertical direction. +
                                                                                                                                                                                                                                                  O D
                                                                                                                                                                                                                                                  L L
                                                                                                                                                                                                                                                  L R
                                                                                                                                                                                                                                                  E O
                                                                                                                                                                                                                                                  H W
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  BottomTop_RightLeft +This is a vertical direction. +
                                                                                                                                                                                                                                                  D O
                                                                                                                                                                                                                                                  L L
                                                                                                                                                                                                                                                  R L
                                                                                                                                                                                                                                                  O E
                                                                                                                                                                                                                                                  W H
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  LeftRight_BottomTop +This is a horizontal direction. +
                                                                                                                                                                                                                                                  WORLD
                                                                                                                                                                                                                                                  HELLO
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  LeftRight_TopBottom +Normal horizontal direction. +
                                                                                                                                                                                                                                                  HELLO
                                                                                                                                                                                                                                                  WORLD
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  RightLeft_BottomTop +This is a horizontal direction. +
                                                                                                                                                                                                                                                  DLROW
                                                                                                                                                                                                                                                  OLLEH
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  RightLeft_TopBottom +This is a horizontal direction.
                                                                                                                                                                                                                                                  RTL +
                                                                                                                                                                                                                                                  OLLEH
                                                                                                                                                                                                                                                  DLROW
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  TopBottom_LeftRight +Normal vertical direction. +
                                                                                                                                                                                                                                                  H W
                                                                                                                                                                                                                                                  E O
                                                                                                                                                                                                                                                  L R
                                                                                                                                                                                                                                                  L L
                                                                                                                                                                                                                                                  O D
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  TopBottom_RightLeft +This is a vertical direction. +
                                                                                                                                                                                                                                                  W H
                                                                                                                                                                                                                                                  O E
                                                                                                                                                                                                                                                  R L
                                                                                                                                                                                                                                                  L L
                                                                                                                                                                                                                                                  D O
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextField.html b/docs/api/Terminal.Gui/Terminal.Gui.TextField.html new file mode 100644 index 0000000000..883937bf6f --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextField.html @@ -0,0 +1,1563 @@ + + + + + + + + Class TextField + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                    Class TextField +

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Single-line text entry View +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Responder
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    View
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    TextField
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    DateField
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    TimeField
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    System.IDisposable
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    + View.Data +
                                                                                                                                                                                                                                                    + + + + + +
                                                                                                                                                                                                                                                    + View.Id +
                                                                                                                                                                                                                                                    + + + + + +
                                                                                                                                                                                                                                                    + View.X +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + View.Y +
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Namespace: Terminal.Gui
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public class TextField : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +The TextField View provides editing functionality and mouse support. +
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Constructors +

                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    TextField()

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Initializes a new instance of the TextField class using Computed positioning. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public TextField()
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    TextField(ustring)

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Initializes a new instance of the TextField class using Computed positioning. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public TextField(ustring text)
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                    NStack.ustringtextInitial text contents.
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    TextField(Int32, Int32, Int32, ustring)

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Initializes a new instance of the TextField class using Absolute positioning. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public TextField(int x, int y, int w, ustring text)
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                    System.Int32xThe x coordinate.
                                                                                                                                                                                                                                                    System.Int32yThe y coordinate.
                                                                                                                                                                                                                                                    System.Int32wThe width.
                                                                                                                                                                                                                                                    NStack.ustringtextInitial text contents.
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    TextField(String)

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Initializes a new instance of the TextField class using Computed positioning. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public TextField(string text)
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                    System.StringtextInitial text contents.
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Properties +

                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    Autocomplete

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Provides autocomplete context menu based on suggestions at the current cursor +position. Populate AllSuggestions to enable this feature. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public IAutocomplete Autocomplete { get; protected set; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    IAutocomplete
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    CanFocus

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public override bool CanFocus { get; set; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                    ContextMenu

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Get the ContextMenu for this view. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public ContextMenu ContextMenu { get; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    ContextMenu
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    CursorPosition

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Sets or gets the current cursor position. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public virtual int CursorPosition { get; set; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    DesiredCursorVisibility

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Get / Set the wished cursor when the field is focused +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public CursorVisibility DesiredCursorVisibility { get; set; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    CursorVisibility
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    Frame

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public override Rect Frame { get; set; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    Rect
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                    HasHistoryChanges

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Indicates whatever the text has history changes or not. +true if the text has history changes false otherwise. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public bool HasHistoryChanges { get; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    IsDirty

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Indicates whatever the text was changed or not. +true if the text was changed false otherwise. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public bool IsDirty { get; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    ReadOnly

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +If set to true its not allow any changes in the text. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public bool ReadOnly { get; set; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    ScrollOffset

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Gets the left offset position. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public int ScrollOffset { get; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    Secret

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Sets the secret property. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public bool Secret { get; set; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +This makes the text entry suitable for entering passwords. +
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    SelectedLength

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Length of the selected text. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public int SelectedLength { get; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    SelectedStart

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Start position of the selected text. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public int SelectedStart { get; set; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    SelectedText

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +The selected text. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public ustring SelectedText { get; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    NStack.ustring
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    Text

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Sets or gets the text held by the view. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public ustring Text { get; set; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    NStack.ustring
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    Used

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Tracks whether the text field should be considered "used", that is, that the user has moved in the entry, so new input should be appended at the cursor position, rather than clearing the entry +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public bool Used { get; set; }
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    ClearAllSelection()

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Clear the selected text. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public void ClearAllSelection()
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    ClearHistoryChanges()

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Allows clearing the Terminal.Gui.HistoryText.HistoryTextItem items updating the original text. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public void ClearHistoryChanges()
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    Copy()

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Copy the selected text to the clipboard. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public virtual void Copy()
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    Cut()

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Cut the selected text to the clipboard. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public virtual void Cut()
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    DeleteAll()

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Deletes all text. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public void DeleteAll()
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    DeleteCharLeft(Boolean)

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Deletes the left character. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public virtual void DeleteCharLeft(bool useOldCursorPos = true)
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                    System.BooleanuseOldCursorPos
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    DeleteCharRight()

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Deletes the right character. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public virtual void DeleteCharRight()
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    InsertText(String, Boolean)

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Inserts the given toAdd text at the current cursor position +exactly as if the user had just typed it +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public void InsertText(string toAdd, bool useOldCursorPos = true)
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                    System.StringtoAddText to add
                                                                                                                                                                                                                                                    System.BooleanuseOldCursorPosIf uses the Terminal.Gui.TextField.oldCursorPos.
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    KillWordBackwards()

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Deletes word backwards. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public virtual void KillWordBackwards()
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    KillWordForwards()

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Deletes word forwards. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public virtual void KillWordForwards()
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    MouseEvent(MouseEvent)

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public override bool MouseEvent(MouseEvent ev)
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                    MouseEventev
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                    OnEnter(View)

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public override bool OnEnter(View view)
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                    Viewview
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                    OnLeave(View)

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public override bool OnLeave(View view)
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                    Viewview
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                    OnTextChanging(ustring)

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Virtual method that invoke the TextChanging event if it's defined. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public virtual TextChangingEventArgs OnTextChanging(ustring newText)
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                    NStack.ustringnewTextThe new text to be replaced.
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    TextChangingEventArgsReturns the TextChangingEventArgs
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    Paste()

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Paste the selected text from the clipboard. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public virtual void Paste()
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    PositionCursor()

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Sets the cursor position. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public override void PositionCursor()
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                    ProcessKey(KeyEvent)

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Processes key presses for the TextField. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public override bool ProcessKey(KeyEvent kb)
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                    KeyEventkb
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +The TextField control responds to the following keys: +
                                                                                                                                                                                                                                                    KeysFunction
                                                                                                                                                                                                                                                    Delete, BackspaceDeletes the character before cursor.
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    Redraw(Rect)

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public override void Redraw(Rect bounds)
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                    Rectbounds
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                    SelectAll()

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Selects all text. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public void SelectAll()
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Events +

                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    TextChanged

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Changed event, raised when the text has changed. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public event Action<ustring> TextChanged
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Event Type
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Action<NStack.ustring>
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +This event is raised when the Text changes. +
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    TextChanging

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +Changing event, raised before the Text changes and can be canceled or changing the new text. +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                    public event Action<TextChangingEventArgs> TextChanging
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Event Type
                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                    System.Action<TextChangingEventArgs>
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + System.IDisposable +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextFieldAutocomplete.html b/docs/api/Terminal.Gui/Terminal.Gui.TextFieldAutocomplete.html new file mode 100644 index 0000000000..ccac7d6645 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextFieldAutocomplete.html @@ -0,0 +1,316 @@ + + + + + + + + Class TextFieldAutocomplete + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                      Class TextFieldAutocomplete +

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +Renders an overlay on another view at a given point that allows selecting +from a range of 'autocomplete' options. +An implementation on a TextField. +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Autocomplete
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      TextFieldAutocomplete
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Implements
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + System.Object.ToString() +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Namespace: Terminal.Gui
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                      public class TextFieldAutocomplete : Autocomplete, IAutocomplete
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      Methods +

                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                      DeleteTextBackwards()

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                      protected override void DeleteTextBackwards()
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                      GetCurrentWord()

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                      protected override string GetCurrentWord()
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                      System.String
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                      InsertText(String)

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                      protected override void InsertText(string accepted)
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                      System.Stringaccepted
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextFormatter.html b/docs/api/Terminal.Gui/Terminal.Gui.TextFormatter.html new file mode 100644 index 0000000000..3d5dd270a1 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextFormatter.html @@ -0,0 +1,1837 @@ + + + + + + + + Class TextFormatter + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                        Class TextFormatter +

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multiple lines, and word-based line wrap. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        TextFormatter
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + System.Object.ToString() +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Namespace: Terminal.Gui
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public class TextFormatter
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Properties +

                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        Alignment

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Controls the horizontal text-alignment property. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public TextAlignment Alignment { get; set; }
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        TextAlignmentThe text alignment.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        AutoSize

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Used by Text to resize the view's Bounds with the Size. +Setting AutoSize to true only work if the Width and Height are null or +Absolute values and doesn't work with Computed layout, +to avoid breaking the Pos and Dim settings. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public bool AutoSize { get; set; }
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        CursorPosition

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Gets the cursor position from HotKey. If the HotKey is defined, the cursor will be positioned over it. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public int CursorPosition { get; set; }
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Int32
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        Direction

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Controls the text-direction property. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public TextDirection Direction { get; set; }
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        TextDirectionThe text vertical alignment.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        HotKey

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Gets the hotkey. Will be an upper case letter or digit. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public Key HotKey { get; }
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        Key
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        HotKeyPos

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +The position in the text of the hotkey. The hotkey will be rendered using the hot color. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public int HotKeyPos { get; set; }
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Int32
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        HotKeySpecifier

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +The specifier character for the hotkey (e.g. '_'). Set to '\xffff' to disable hotkey support for this View instance. The default is '\xffff'. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public Rune HotKeySpecifier { get; set; }
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Rune
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        HotKeyTagMask

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Specifies the mask to apply to the hotkey to tag it as the hotkey. The default value of 0x100000 causes +the underlying Rune to be identified as a "private use" Unicode character. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public uint HotKeyTagMask { get; set; }
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.UInt32
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        Lines

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Gets the formatted lines. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public List<ustring> Lines { get; }
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Collections.Generic.List<NStack.ustring>
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        +Upon a 'get' of this property, if the text needs to be formatted (if NeedsFormat is true) +Format(ustring, Int32, Boolean, Boolean, Boolean, Int32, TextDirection) will be called internally. +

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        NeedsFormat

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Gets or sets whether the TextFormatter needs to format the text when Draw(Rect, Attribute, Attribute, Rect) is called. +If it is false when Draw is called, the Draw call will be faster. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public bool NeedsFormat { get; set; }
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        +This is set to true when the properties of TextFormatter are set. +

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        PreserveTrailingSpaces

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Gets or sets a flag that determines whether Text will have trailing spaces preserved +or not when WordWrap(ustring, Int32, Boolean, Int32, TextDirection) is enabled. If `true` any trailing spaces will be trimmed when +either the Text property is changed or when WordWrap(ustring, Int32, Boolean, Int32, TextDirection) is set to `true`. +The default is `false`. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public bool PreserveTrailingSpaces { get; set; }
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        Size

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Gets or sets the size of the area the text will be constrained to when formatted. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public Size Size { get; set; }
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        Size
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        Text

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +The text to be displayed. This text is never modified. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public virtual ustring Text { get; set; }
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        NStack.ustring
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        VerticalAlignment

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Controls the vertical text-alignment property. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public VerticalTextAlignment VerticalAlignment { get; set; }
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        VerticalTextAlignmentThe text vertical alignment.
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        CalcRect(Int32, Int32, ustring, TextDirection)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Calculates the rectangle required to hold text, assuming no word wrapping. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static Rect CalcRect(int x, int y, ustring text, TextDirection direction = TextDirection.LeftRight_TopBottom)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        System.Int32xThe x location of the rectangle
                                                                                                                                                                                                                                                        System.Int32yThe y location of the rectangle
                                                                                                                                                                                                                                                        NStack.ustringtextThe text to measure
                                                                                                                                                                                                                                                        TextDirectiondirectionThe text direction.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        Rect
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        ClipAndJustify(ustring, Int32, Boolean, TextDirection)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Justifies text within a specified width. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static ustring ClipAndJustify(ustring text, int width, bool justify, TextDirection textDirection = TextDirection.LeftRight_TopBottom)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        NStack.ustringtextThe text to justify.
                                                                                                                                                                                                                                                        System.Int32widthIf the text length is greater that width it will be clipped.
                                                                                                                                                                                                                                                        System.BooleanjustifyJustify.
                                                                                                                                                                                                                                                        TextDirectiontextDirectionThe text direction.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        NStack.ustringJustified and clipped text.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        ClipAndJustify(ustring, Int32, TextAlignment, TextDirection)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Justifies text within a specified width. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static ustring ClipAndJustify(ustring text, int width, TextAlignment talign, TextDirection textDirection = TextDirection.LeftRight_TopBottom)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        NStack.ustringtextThe text to justify.
                                                                                                                                                                                                                                                        System.Int32widthIf the text length is greater that width it will be clipped.
                                                                                                                                                                                                                                                        TextAlignmenttalignAlignment.
                                                                                                                                                                                                                                                        TextDirectiontextDirectionThe text direction.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        NStack.ustringJustified and clipped text.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        ClipOrPad(String, Int32)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Adds trailing whitespace or truncates text +so that it fits exactly width console units. +Note that some unicode characters take 2+ columns +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static string ClipOrPad(string text, int width)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        System.Stringtext
                                                                                                                                                                                                                                                        System.Int32width
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.String
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        Draw(Rect, Attribute, Attribute, Rect)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Draws the text held by TextFormatter to Driver using the colors specified. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public void Draw(Rect bounds, Attribute normalColor, Attribute hotColor, Rect containerBounds = default(Rect))
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        RectboundsSpecifies the screen-relative location and maximum size for drawing the text.
                                                                                                                                                                                                                                                        AttributenormalColorThe color to use for all text except the hotkey
                                                                                                                                                                                                                                                        AttributehotColorThe color to use to draw the hotkey
                                                                                                                                                                                                                                                        RectcontainerBoundsSpecifies the screen-relative location and maximum container size.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        FindHotKey(ustring, Rune, Boolean, out Int32, out Key)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Finds the hotkey and its location in text. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static bool FindHotKey(ustring text, Rune hotKeySpecifier, bool firstUpperCase, out int hotPos, out Key hotKey)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        NStack.ustringtextThe text to look in.
                                                                                                                                                                                                                                                        System.RunehotKeySpecifierThe hotkey specifier (e.g. '_') to look for.
                                                                                                                                                                                                                                                        System.BooleanfirstUpperCaseIf true the legacy behavior of identifying the first upper case character as the hotkey will be enabled. +Regardless of the value of this parameter, hotKeySpecifier takes precedence.
                                                                                                                                                                                                                                                        System.Int32hotPosOutputs the Rune index into text.
                                                                                                                                                                                                                                                        KeyhotKeyOutputs the hotKey.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Booleantrue if a hotkey was found; false otherwise.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        Format(ustring, Int32, Boolean, Boolean, Boolean, Int32, TextDirection)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Reformats text into lines, applying text alignment and optionally wrapping text to new lines on word boundaries. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static List<ustring> Format(ustring text, int width, bool justify, bool wordWrap, bool preserveTrailingSpaces = false, int tabWidth = 0, TextDirection textDirection = TextDirection.LeftRight_TopBottom)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        NStack.ustringtext
                                                                                                                                                                                                                                                        System.Int32widthThe width to bound the text to for word wrapping and clipping.
                                                                                                                                                                                                                                                        System.BooleanjustifySpecifies whether the text should be justified.
                                                                                                                                                                                                                                                        System.BooleanwordWrapIf true, the text will be wrapped to new lines as need. If false, forces text to fit a single line. Line breaks are converted to spaces. The text will be clipped to width
                                                                                                                                                                                                                                                        System.BooleanpreserveTrailingSpacesIf true and 'wordWrap' also true, the wrapped text will keep the trailing spaces. If false, the trailing spaces will be trimmed.
                                                                                                                                                                                                                                                        System.Int32tabWidthThe tab width.
                                                                                                                                                                                                                                                        TextDirectiontextDirectionThe text direction.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Collections.Generic.List<NStack.ustring>A list of word wrapped lines.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        +An empty text string will result in one empty line. +

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        +If width is 0, a single, empty line will be returned. +

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        +If width is int.MaxValue, the text will be formatted to the maximum width possible. +

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        Format(ustring, Int32, TextAlignment, Boolean, Boolean, Int32, TextDirection)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Reformats text into lines, applying text alignment and optionally wrapping text to new lines on word boundaries. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static List<ustring> Format(ustring text, int width, TextAlignment talign, bool wordWrap, bool preserveTrailingSpaces = false, int tabWidth = 0, TextDirection textDirection = TextDirection.LeftRight_TopBottom)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        NStack.ustringtext
                                                                                                                                                                                                                                                        System.Int32widthThe width to bound the text to for word wrapping and clipping.
                                                                                                                                                                                                                                                        TextAlignmenttalignSpecifies how the text will be aligned horizontally.
                                                                                                                                                                                                                                                        System.BooleanwordWrapIf true, the text will be wrapped to new lines as need. If false, forces text to fit a single line. Line breaks are converted to spaces. The text will be clipped to width
                                                                                                                                                                                                                                                        System.BooleanpreserveTrailingSpacesIf true and 'wordWrap' also true, the wrapped text will keep the trailing spaces. If false, the trailing spaces will be trimmed.
                                                                                                                                                                                                                                                        System.Int32tabWidthThe tab width.
                                                                                                                                                                                                                                                        TextDirectiontextDirectionThe text direction.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Collections.Generic.List<NStack.ustring>A list of word wrapped lines.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        +An empty text string will result in one empty line. +

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        +If width is 0, a single, empty line will be returned. +

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        +If width is int.MaxValue, the text will be formatted to the maximum width possible. +

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        GetMaxColsForWidth(List<ustring>, Int32)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Gets the index position from the list based on the width. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static int GetMaxColsForWidth(List<ustring> lines, int width)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        System.Collections.Generic.List<NStack.ustring>linesThe lines.
                                                                                                                                                                                                                                                        System.Int32widthThe width.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Int32The index of the list that fit the width.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        GetMaxLengthForWidth(ustring, Int32)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Gets the index position from the text based on the width. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static int GetMaxLengthForWidth(ustring text, int width)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        NStack.ustringtextThe text.
                                                                                                                                                                                                                                                        System.Int32widthThe width.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Int32The index of the text that fit the width.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        GetMaxLengthForWidth(List<Rune>, Int32)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Gets the index position from the list based on the width. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static int GetMaxLengthForWidth(List<Rune> runes, int width)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        System.Collections.Generic.List<System.Rune>runesThe runes.
                                                                                                                                                                                                                                                        System.Int32widthThe width.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Int32The index of the list that fit the width.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        GetSumMaxCharWidth(ustring, Int32, Int32)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Gets the maximum characters width from the text based on the startIndex +and the length. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static int GetSumMaxCharWidth(ustring text, int startIndex = -1, int length = -1)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        NStack.ustringtextThe text.
                                                                                                                                                                                                                                                        System.Int32startIndexThe start index.
                                                                                                                                                                                                                                                        System.Int32lengthThe length.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Int32The maximum characters width.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        GetSumMaxCharWidth(List<ustring>, Int32, Int32)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Gets the maximum characters width from the list based on the startIndex +and the length. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static int GetSumMaxCharWidth(List<ustring> lines, int startIndex = -1, int length = -1)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        System.Collections.Generic.List<NStack.ustring>linesThe lines.
                                                                                                                                                                                                                                                        System.Int32startIndexThe start index.
                                                                                                                                                                                                                                                        System.Int32lengthThe length.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Int32The maximum characters width.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        GetTextWidth(ustring)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Gets the total width of the passed text. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static int GetTextWidth(ustring text)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        NStack.ustringtext
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Int32The text width.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        IsHorizontalDirection(TextDirection)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Check if it is a horizontal direction +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static bool IsHorizontalDirection(TextDirection textDirection)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        TextDirectiontextDirection
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        IsLeftToRight(TextDirection)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Check if it is Left to Right direction +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static bool IsLeftToRight(TextDirection textDirection)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        TextDirectiontextDirection
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        IsTopToBottom(TextDirection)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Check if it is Top to Bottom direction +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static bool IsTopToBottom(TextDirection textDirection)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        TextDirectiontextDirection
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        IsVerticalDirection(TextDirection)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Check if it is a vertical direction +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static bool IsVerticalDirection(TextDirection textDirection)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        TextDirectiontextDirection
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        Justify(ustring, Int32, Char, TextDirection)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Justifies the text to fill the width provided. Space will be added between words (demarked by spaces and tabs) to +make the text just fit width. Spaces will not be added to the ends. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static ustring Justify(ustring text, int width, char spaceChar = ' ', TextDirection textDirection = TextDirection.LeftRight_TopBottom)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        NStack.ustringtext
                                                                                                                                                                                                                                                        System.Int32width
                                                                                                                                                                                                                                                        System.CharspaceCharCharacter to replace whitespace and pad with. For debugging purposes.
                                                                                                                                                                                                                                                        TextDirectiontextDirectionThe text direction.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        NStack.ustringThe justified text.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        MaxLines(ustring, Int32)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Computes the number of lines needed to render the specified text given the width. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static int MaxLines(ustring text, int width)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        NStack.ustringtextText, may contain newlines.
                                                                                                                                                                                                                                                        System.Int32widthThe minimum width for the text.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Int32Number of lines.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        MaxWidth(ustring, Int32)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Computes the maximum width needed to render the text (single line or multiple lines) given a minimum width. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static int MaxWidth(ustring text, int width)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        NStack.ustringtextText, may contain newlines.
                                                                                                                                                                                                                                                        System.Int32widthThe minimum width for the text.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Int32Max width of lines.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        RemoveHotKeySpecifier(ustring, Int32, Rune)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Removes the hotkey specifier from text. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static ustring RemoveHotKeySpecifier(ustring text, int hotPos, Rune hotKeySpecifier)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        NStack.ustringtextThe text to manipulate.
                                                                                                                                                                                                                                                        System.Int32hotPosReturns the position of the hot-key in the text. -1 if not found.
                                                                                                                                                                                                                                                        System.RunehotKeySpecifierThe hot-key specifier (e.g. '_') to look for.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        NStack.ustringThe input text with the hotkey specifier ('_') removed.
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        ReplaceHotKeyWithTag(ustring, Int32)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Replaces the Rune at the index specified by the hotPos parameter with a tag identifying +it as the hotkey. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public ustring ReplaceHotKeyWithTag(ustring text, int hotPos)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        NStack.ustringtextThe text to tag the hotkey in.
                                                                                                                                                                                                                                                        System.Int32hotPosThe Rune index of the hotkey in text.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        NStack.ustringThe text with the hotkey tagged.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +The returned string will not render correctly without first un-doing the tag. To undo the tag, search for +Runes with a bitmask of otKeyTagMask and remove that bitmask. +
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        WordWrap(ustring, Int32, Boolean, Int32, TextDirection)

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Formats the provided text to fit within the width provided using word wrapping. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public static List<ustring> WordWrap(ustring text, int width, bool preserveTrailingSpaces = false, int tabWidth = 0, TextDirection textDirection = TextDirection.LeftRight_TopBottom)
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                        NStack.ustringtextThe text to word wrap
                                                                                                                                                                                                                                                        System.Int32widthThe width to contain the text to
                                                                                                                                                                                                                                                        System.BooleanpreserveTrailingSpacesIf true, the wrapped text will keep the trailing spaces. + If false, the trailing spaces will be trimmed.
                                                                                                                                                                                                                                                        System.Int32tabWidthThe tab width.
                                                                                                                                                                                                                                                        TextDirectiontextDirectionThe text direction.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Collections.Generic.List<NStack.ustring>Returns a list of word wrapped lines.
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        +This method does not do any justification. +

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        +This method strips Newline ('\n' and '\r\n') sequences before processing. +

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Events +

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        HotKeyChanged

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +Event invoked when the HotKey is changed. +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                        public event Action<Key> HotKeyChanged
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                        System.Action<Key>
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextValidateField.html b/docs/api/Terminal.Gui/Terminal.Gui.TextValidateField.html new file mode 100644 index 0000000000..f8aa2904a2 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextValidateField.html @@ -0,0 +1,816 @@ + + + + + + + + Class TextValidateField + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                          Class TextValidateField +

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +Text field that validates input through a ITextValidateProvider +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Responder
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          View
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          TextValidateField
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Implements
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          System.IDisposable
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                          + View.Data +
                                                                                                                                                                                                                                                          + + + + + + +
                                                                                                                                                                                                                                                          + View.Id +
                                                                                                                                                                                                                                                          + + + + + + +
                                                                                                                                                                                                                                                          + View.X +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + View.Y +
                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Namespace: Terminal.Gui
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                          public class TextValidateField : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Constructors +

                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                          TextValidateField()

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +Initializes a new instance of the TextValidateField class using Computed positioning. +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                          public TextValidateField()
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                          TextValidateField(ITextValidateProvider)

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +Initializes a new instance of the TextValidateField class using Computed positioning. +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                          public TextValidateField(ITextValidateProvider provider)
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                          ITextValidateProviderprovider
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Properties +

                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                          IsValid

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +This property returns true if the input is valid. +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                          public virtual bool IsValid { get; }
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                          Provider

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +Provider +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                          public ITextValidateProvider Provider { get; set; }
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                          ITextValidateProvider
                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                          Text

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +Text +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                          public ustring Text { get; set; }
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                          NStack.ustring
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                          MouseEvent(MouseEvent)

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                          public override bool MouseEvent(MouseEvent mouseEvent)
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                          MouseEventmouseEvent
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                          PositionCursor()

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                          public override void PositionCursor()
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                          ProcessKey(KeyEvent)

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                          public override bool ProcessKey(KeyEvent kb)
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                          KeyEventkb
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                          Redraw(Rect)

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                          public override void Redraw(Rect bounds)
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                          Rectbounds
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                          Implements

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + System.IDisposable +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.ITextValidateProvider.html b/docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.ITextValidateProvider.html new file mode 100644 index 0000000000..b208408052 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.ITextValidateProvider.html @@ -0,0 +1,499 @@ + + + + + + + + Interface ITextValidateProvider + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                            Interface ITextValidateProvider +

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +TextValidateField Providers Interface. +All TextValidateField are created with a ITextValidateProvider. +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Namespace: Terminal.Gui.TextValidateProviders
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                            public interface ITextValidateProvider
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Properties +

                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                            DisplayText

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +Gets the formatted string for display. +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                            ustring DisplayText { get; }
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                            NStack.ustring
                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                            Fixed

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +Set that this provider uses a fixed width. +e.g. Masked ones are fixed. +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                            bool Fixed { get; }
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                            IsValid

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +True if the input is valid, otherwise false. +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                            bool IsValid { get; }
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                            Text

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +Set the input text and get the current value. +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                            ustring Text { get; set; }
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                            NStack.ustring
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                            Cursor(Int32)

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +Set Cursor position to pos. +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                            int Cursor(int pos)
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                            System.Int32pos
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                            System.Int32Return first valid position.
                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                            CursorEnd()

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +Find the last valid character position. +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                            int CursorEnd()
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                            System.Int32New cursor position.
                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                            CursorLeft(Int32)

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +First valid position before pos. +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                            int CursorLeft(int pos)
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                            System.Int32pos
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                            System.Int32New cursor position if any, otherwise returns pos
                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                            CursorRight(Int32)

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +First valid position after pos. +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                            int CursorRight(int pos)
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                            System.Int32posCurrent position.
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                            System.Int32New cursor position if any, otherwise returns pos
                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                            CursorStart()

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +Find the first valid character position. +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                            int CursorStart()
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                            System.Int32New cursor position.
                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                            Delete(Int32)

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +Deletes the current character in pos. +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                            bool Delete(int pos)
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                            System.Int32pos
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                            System.Booleantrue if the character was successfully removed, otherwise false.
                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                            InsertAt(Char, Int32)

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +Insert character ch in position pos. +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                            bool InsertAt(char ch, int pos)
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                            System.Charch
                                                                                                                                                                                                                                                            System.Int32pos
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                            System.Booleantrue if the character was successfully inserted, otherwise false.
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.NetMaskedTextProvider.html b/docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.NetMaskedTextProvider.html new file mode 100644 index 0000000000..ec8fed5d03 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.NetMaskedTextProvider.html @@ -0,0 +1,569 @@ + + + + + + + + Class NetMaskedTextProvider + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                              Class NetMaskedTextProvider +

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +.Net MaskedTextProvider Provider for TextValidateField. +

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Wrapper around MaskedTextProvider

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Masking elements

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Inheritance
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              NetMaskedTextProvider
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Implements
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + System.Object.ToString() +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Namespace: Terminal.Gui.TextValidateProviders
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                              public class NetMaskedTextProvider : ITextValidateProvider
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Constructors +

                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              NetMaskedTextProvider(String)

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +Empty Constructor +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                              public NetMaskedTextProvider(string mask)
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                              System.Stringmask
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Properties +

                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              DisplayText

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                              public ustring DisplayText { get; }
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                              NStack.ustring
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              Fixed

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                              public bool Fixed { get; }
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                              System.Boolean
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              IsValid

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                              public bool IsValid { get; }
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                              System.Boolean
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              Mask

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +Mask property +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                              public ustring Mask { get; set; }
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                              NStack.ustring
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              Text

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                              public ustring Text { get; set; }
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                              NStack.ustring
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Methods +

                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              Cursor(Int32)

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                              public int Cursor(int pos)
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                              System.Int32pos
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              CursorEnd()

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                              public int CursorEnd()
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              CursorLeft(Int32)

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                              public int CursorLeft(int pos)
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                              System.Int32pos
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              CursorRight(Int32)

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                              public int CursorRight(int pos)
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                              System.Int32pos
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              CursorStart()

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                              public int CursorStart()
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              Delete(Int32)

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                              public bool Delete(int pos)
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                              System.Int32pos
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                              System.Boolean
                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                              InsertAt(Char, Int32)

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                              public bool InsertAt(char ch, int pos)
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                              System.Charch
                                                                                                                                                                                                                                                              System.Int32pos
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                              System.Boolean
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Implements

                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.TextRegexProvider.html b/docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.TextRegexProvider.html new file mode 100644 index 0000000000..61ac3c7cbf --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.TextRegexProvider.html @@ -0,0 +1,591 @@ + + + + + + + + Class TextRegexProvider + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                Class TextRegexProvider +

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +Regex Provider for TextValidateField. +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                TextRegexProvider
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Implements
                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + System.Object.ToString() +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Namespace: Terminal.Gui.TextValidateProviders
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public class TextRegexProvider : ITextValidateProvider
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Constructors +

                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                TextRegexProvider(String)

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +Empty Constructor. +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public TextRegexProvider(string pattern)
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                System.Stringpattern
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Properties +

                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                DisplayText

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public ustring DisplayText { get; }
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                NStack.ustring
                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                Fixed

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public bool Fixed { get; }
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                IsValid

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public bool IsValid { get; }
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                Pattern

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +Regex pattern property. +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public ustring Pattern { get; set; }
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                NStack.ustring
                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                Text

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public ustring Text { get; set; }
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                NStack.ustring
                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                ValidateOnInput

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +When true, validates with the regex pattern on each input, preventing the input if it's not valid. +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public bool ValidateOnInput { get; set; }
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Methods +

                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                Cursor(Int32)

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public int Cursor(int pos)
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                System.Int32pos
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                CursorEnd()

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public int CursorEnd()
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                CursorLeft(Int32)

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public int CursorLeft(int pos)
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                System.Int32pos
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                CursorRight(Int32)

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public int CursorRight(int pos)
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                System.Int32pos
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                CursorStart()

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public int CursorStart()
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                Delete(Int32)

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public bool Delete(int pos)
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                System.Int32pos
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                InsertAt(Char, Int32)

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                public bool InsertAt(char ch, int pos)
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                System.Charch
                                                                                                                                                                                                                                                                System.Int32pos
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Implements

                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.html b/docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.html new file mode 100644 index 0000000000..63400eec1f --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextValidateProviders.html @@ -0,0 +1,140 @@ + + + + + + + + Namespace Terminal.Gui.TextValidateProviders + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextView.html b/docs/api/Terminal.Gui/Terminal.Gui.TextView.html new file mode 100644 index 0000000000..0bda273d26 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextView.html @@ -0,0 +1,2265 @@ + + + + + + + + Class TextView + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                    Class TextView +

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Multi-line text editing View +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Responder
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    View
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    TextView
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    System.IDisposable
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    + View.Data +
                                                                                                                                                                                                                                                                    + + + + + +
                                                                                                                                                                                                                                                                    + View.Id +
                                                                                                                                                                                                                                                                    + + + + + +
                                                                                                                                                                                                                                                                    + View.X +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + View.Y +
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public class TextView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    +TextView provides a multi-line text editor. Users interact +with it with the standard Emacs commands for movement or the arrow +keys. +

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    ShortcutAction performed
                                                                                                                                                                                                                                                                    Left cursor, Control-b + Moves the editing point left. +
                                                                                                                                                                                                                                                                    Right cursor, Control-f + Moves the editing point right. +
                                                                                                                                                                                                                                                                    Alt-b + Moves one word back. +
                                                                                                                                                                                                                                                                    Alt-f + Moves one word forward. +
                                                                                                                                                                                                                                                                    Up cursor, Control-p + Moves the editing point one line up. +
                                                                                                                                                                                                                                                                    Down cursor, Control-n + Moves the editing point one line down +
                                                                                                                                                                                                                                                                    Home key, Control-a + Moves the cursor to the beginning of the line. +
                                                                                                                                                                                                                                                                    End key, Control-e + Moves the cursor to the end of the line. +
                                                                                                                                                                                                                                                                    Control-Home + Scrolls to the first line and moves the cursor there. +
                                                                                                                                                                                                                                                                    Control-End + Scrolls to the last line and moves the cursor there. +
                                                                                                                                                                                                                                                                    Delete, Control-d + Deletes the character in front of the cursor. +
                                                                                                                                                                                                                                                                    Backspace + Deletes the character behind the cursor. +
                                                                                                                                                                                                                                                                    Control-k + Deletes the text until the end of the line and replaces the kill buffer + with the deleted text. You can paste this text in a different place by + using Control-y. +
                                                                                                                                                                                                                                                                    Control-y + Pastes the content of the kill ring into the current position. +
                                                                                                                                                                                                                                                                    Alt-d + Deletes the word above the cursor and adds it to the kill ring. You + can paste the contents of the kill ring with Control-y. +
                                                                                                                                                                                                                                                                    Control-q + Quotes the next input character, to prevent the normal processing of + key handling to take place. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Constructors +

                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    TextView()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Initializes a TextView on the specified area, +with dimensions controlled with the X, Y, Width and Height properties. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public TextView()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    TextView(Rect)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Initializes a TextView on the specified area, with absolute position and size. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public TextView(Rect frame)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    Rectframe
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Properties +

                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    AllowsReturn

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Gets or sets a value indicating whether pressing ENTER in a TextView +creates a new line of text in the view or activates the default button for the toplevel. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public bool AllowsReturn { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    AllowsTab

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Gets or sets whether the TextView inserts a tab character into the text or ignores +tab input. If set to `false` and the user presses the tab key (or shift-tab) the focus will move to the +next view (or previous with shift-tab). The default is `true`; if the user presses the tab key, a tab +character will be inserted into the text. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public bool AllowsTab { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    Autocomplete

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Provides autocomplete context menu based on suggestions at the current cursor +position. Populate AllSuggestions to enable this feature +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public IAutocomplete Autocomplete { get; protected set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    IAutocomplete
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    BottomOffset

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +The bottom offset needed to use a horizontal scrollbar or for another reason. +This is only needed with the keyboard navigation. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public int BottomOffset { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    CanFocus

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public override bool CanFocus { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                    ContextMenu

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Get the ContextMenu for this view. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public ContextMenu ContextMenu { get; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    ContextMenu
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    CurrentColumn

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Gets the cursor column. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public int CurrentColumn { get; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Int32The cursor column.
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    CurrentRow

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Gets the current cursor row. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public int CurrentRow { get; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    CursorPosition

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Sets or gets the current cursor position. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public Point CursorPosition { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    Point
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    DesiredCursorVisibility

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Get / Set the wished cursor when the field is focused +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public CursorVisibility DesiredCursorVisibility { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    CursorVisibility
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    Frame

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public override Rect Frame { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    Rect
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                    HasHistoryChanges

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Indicates whatever the text has history changes or not. +true if the text has history changes false otherwise. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public bool HasHistoryChanges { get; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    IsDirty

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Indicates whatever the text was changed or not. +true if the text was changed false otherwise. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public bool IsDirty { get; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    LeftColumn

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Gets or sets the left column. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public int LeftColumn { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    Lines

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Gets the number of lines. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public int Lines { get; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    Maxlength

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Gets the maximum visible length line. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public int Maxlength { get; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    Multiline

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Gets or sets a value indicating whether this TextView is a multiline text view. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public bool Multiline { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    ReadOnly

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Gets or sets whether the TextView is in read-only mode or not +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public bool ReadOnly { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.BooleanBoolean value(Default false)
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    RightOffset

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +The right offset needed to use a vertical scrollbar or for another reason. +This is only needed with the keyboard navigation. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public int RightOffset { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    SelectedLength

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Length of the selected text. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public int SelectedLength { get; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    SelectedText

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +The selected text. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public ustring SelectedText { get; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    NStack.ustring
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    Selecting

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Get or sets the selecting. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public bool Selecting { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    SelectionStartColumn

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Start column position of the selected text. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public int SelectionStartColumn { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    SelectionStartRow

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Start row position of the selected text. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public int SelectionStartRow { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    TabWidth

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Gets or sets a value indicating the number of whitespace when pressing the TAB key. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public int TabWidth { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    Text

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Sets or gets the text in the TextView. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public override ustring Text { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    NStack.ustring
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    TopRow

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Gets or sets the top row. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public int TopRow { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    Used

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Tracks whether the text view should be considered "used", that is, that the user has moved in the entry, +so new input should be appended at the cursor position, rather than clearing the entry +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public bool Used { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    WordWrap

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Allows word wrap the to fit the available container width. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public bool WordWrap { get; set; }
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    ClearHistoryChanges()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Allows clearing the Terminal.Gui.HistoryText.HistoryTextItem items updating the original text. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public void ClearHistoryChanges()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    CloseFile()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Closes the contents of the stream into the TextView. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public bool CloseFile()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Booleantrue, if stream was closed, false otherwise.
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    ColorNormal()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Sets the driver to the default color for the control where no text is being rendered. Defaults to Normal. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    protected virtual void ColorNormal()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    ColorNormal(List<Rune>, Int32)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Sets the Driver to an appropriate color for rendering the given idx of the +current line. Override to provide custom coloring by calling SetAttribute(Attribute) +Defaults to Normal. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    protected virtual void ColorNormal(List<Rune> line, int idx)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    System.Collections.Generic.List<System.Rune>line
                                                                                                                                                                                                                                                                    System.Int32idx
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    ColorSelection(List<Rune>, Int32)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Sets the Driver to an appropriate color for rendering the given idx of the +current line. Override to provide custom coloring by calling SetAttribute(Attribute) +Defaults to Focus. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    protected virtual void ColorSelection(List<Rune> line, int idx)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    System.Collections.Generic.List<System.Rune>line
                                                                                                                                                                                                                                                                    System.Int32idx
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    ColorUsed(List<Rune>, Int32)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Sets the Driver to an appropriate color for rendering the given idx of the +current line. Override to provide custom coloring by calling SetAttribute(Attribute) +Defaults to HotFocus. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    protected virtual void ColorUsed(List<Rune> line, int idx)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    System.Collections.Generic.List<System.Rune>line
                                                                                                                                                                                                                                                                    System.Int32idx
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    Copy()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Copy the selected text to the clipboard contents. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public void Copy()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    Cut()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Cut the selected text to the clipboard contents. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public void Cut()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    DeleteAll()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Deletes all text. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public void DeleteAll()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    DeleteCharLeft()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Deletes all the selected or a single character at left from the position of the cursor. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public void DeleteCharLeft()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    DeleteCharRight()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Deletes all the selected or a single character at right from the position of the cursor. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public void DeleteCharRight()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    FindNextText(ustring, out Boolean, Boolean, Boolean, ustring, Boolean)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Find the next text based on the match case with the option to replace it. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public bool FindNextText(ustring textToFind, out bool gaveFullTurn, bool matchCase = false, bool matchWholeWord = false, ustring textToReplace = null, bool replace = false)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    NStack.ustringtextToFindThe text to find.
                                                                                                                                                                                                                                                                    System.BooleangaveFullTurntrueIf all the text was forward searched.falseotherwise.
                                                                                                                                                                                                                                                                    System.BooleanmatchCaseThe match case setting.
                                                                                                                                                                                                                                                                    System.BooleanmatchWholeWordThe match whole word setting.
                                                                                                                                                                                                                                                                    NStack.ustringtextToReplaceThe text to replace.
                                                                                                                                                                                                                                                                    System.BooleanreplacetrueIf is replacing.falseotherwise.
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.BooleantrueIf the text was found.falseotherwise.
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    FindPreviousText(ustring, out Boolean, Boolean, Boolean, ustring, Boolean)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Find the previous text based on the match case with the option to replace it. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public bool FindPreviousText(ustring textToFind, out bool gaveFullTurn, bool matchCase = false, bool matchWholeWord = false, ustring textToReplace = null, bool replace = false)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    NStack.ustringtextToFindThe text to find.
                                                                                                                                                                                                                                                                    System.BooleangaveFullTurntrueIf all the text was backward searched.falseotherwise.
                                                                                                                                                                                                                                                                    System.BooleanmatchCaseThe match case setting.
                                                                                                                                                                                                                                                                    System.BooleanmatchWholeWordThe match whole word setting.
                                                                                                                                                                                                                                                                    NStack.ustringtextToReplaceThe text to replace.
                                                                                                                                                                                                                                                                    System.BooleanreplacetrueIf the text was found.falseotherwise.
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.BooleantrueIf the text was found.falseotherwise.
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    FindTextChanged()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Reset the flag to stop continuous find. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public void FindTextChanged()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    GetCurrentLine()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Returns the characters on the current line (where the cursor is positioned). +Use CurrentColumn to determine the position of the cursor within +that line +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public List<Rune> GetCurrentLine()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Collections.Generic.List<System.Rune>
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    InsertText(String)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Inserts the given toAdd text at the current cursor position +exactly as if the user had just typed it +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public void InsertText(string toAdd)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    System.StringtoAddText to add
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    LoadFile(String)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Loads the contents of the file into the TextView. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public bool LoadFile(string path)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    System.StringpathPath to the file to load.
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Booleantrue, if file was loaded, false otherwise.
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    LoadStream(Stream)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Loads the contents of the stream into the TextView. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public void LoadStream(Stream stream)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    System.IO.StreamstreamStream to load the contents from.
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    MouseEvent(MouseEvent)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public override bool MouseEvent(MouseEvent ev)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    MouseEventev
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                    MoveEnd()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Will scroll the TextView to the last line and position the cursor there. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public void MoveEnd()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    MoveHome()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Will scroll the TextView to the first line and position the cursor there. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public void MoveHome()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    OnEnter(View)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public override bool OnEnter(View view)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    Viewview
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                    OnKeyUp(KeyEvent)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public override bool OnKeyUp(KeyEvent kb)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    KeyEventkb
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                    OnLeave(View)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public override bool OnLeave(View view)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    Viewview
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                    Paste()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Paste the clipboard contents into the current selected position. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public void Paste()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    PositionCursor()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Positions the cursor on the current row and column +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public override void PositionCursor()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                    ProcessKey(KeyEvent)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public override bool ProcessKey(KeyEvent kb)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    KeyEventkb
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                    Redraw(Rect)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public override void Redraw(Rect bounds)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    Rectbounds
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                    ReplaceAllText(ustring, Boolean, Boolean, ustring)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Replaces all the text based on the match case. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public bool ReplaceAllText(ustring textToFind, bool matchCase = false, bool matchWholeWord = false, ustring textToReplace = null)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    NStack.ustringtextToFindThe text to find.
                                                                                                                                                                                                                                                                    System.BooleanmatchCaseThe match case setting.
                                                                                                                                                                                                                                                                    System.BooleanmatchWholeWordThe match whole word setting.
                                                                                                                                                                                                                                                                    NStack.ustringtextToReplaceThe text to replace.
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.BooleantrueIf the text was found.falseotherwise.
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    ScrollTo(Int32, Boolean)

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Will scroll the TextView to display the specified row at the top if isRow is true or +will scroll the TextView to display the specified column at the left if isRow is false. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public void ScrollTo(int idx, bool isRow = true)
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                    System.Int32idxRow that should be displayed at the top or Column that should be displayed at the left, + if the value is negative it will be reset to zero
                                                                                                                                                                                                                                                                    System.BooleanisRowIf true (default) the idx is a row, column otherwise.
                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                    SelectAll()

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Select all text. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public void SelectAll()
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Events +

                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    TextChanged

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +Raised when the Text of the TextView changes. +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                    public event Action TextChanged
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Event Type
                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                    System.Action
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + System.IDisposable +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextViewAutocomplete.html b/docs/api/Terminal.Gui/Terminal.Gui.TextViewAutocomplete.html new file mode 100644 index 0000000000..bdba37df36 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextViewAutocomplete.html @@ -0,0 +1,316 @@ + + + + + + + + Class TextViewAutocomplete + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                      Class TextViewAutocomplete +

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +Renders an overlay on another view at a given point that allows selecting +from a range of 'autocomplete' options. +An implementation on a TextView. +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Autocomplete
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      TextViewAutocomplete
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Implements
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + System.Object.ToString() +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                      public class TextViewAutocomplete : Autocomplete, IAutocomplete
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Methods +

                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                      DeleteTextBackwards()

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                      protected override void DeleteTextBackwards()
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                      GetCurrentWord()

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                      protected override string GetCurrentWord()
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                      System.String
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                      InsertText(String)

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                      protected override void InsertText(string accepted)
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                      System.Stringaccepted
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Thickness.html b/docs/api/Terminal.Gui/Terminal.Gui.Thickness.html new file mode 100644 index 0000000000..eccb271a20 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Thickness.html @@ -0,0 +1,346 @@ + + + + + + + + Struct Thickness + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                        Struct Thickness +

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +Describes the thickness of a frame around a rectangle. Four System.Int32 values describe +the Left, Top, Right, and Bottom sides +of the rectangle, respectively. +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + System.ValueType.Equals(System.Object) +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + System.ValueType.GetHashCode() +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                        public struct Thickness
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Constructors +

                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                        Thickness(Int32)

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +Initializes a new instance of the Thickness structure that has the +specified uniform length on each side. +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                        public Thickness(int length)
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                        System.Int32length
                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                        Thickness(Int32, Int32, Int32, Int32)

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +Initializes a new instance of the Thickness structure that has specific +lengths (supplied as a System.Int32) applied to each side of the rectangle. +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                        public Thickness(int left, int top, int right, int bottom)
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                        System.Int32left
                                                                                                                                                                                                                                                                        System.Int32top
                                                                                                                                                                                                                                                                        System.Int32right
                                                                                                                                                                                                                                                                        System.Int32bottom
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Fields +

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Bottom

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +Gets or sets the width, in integers, of the lower side of the bounding rectangle. +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                        public int Bottom
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                        System.Int32
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Left

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +Gets or sets the width, in integers, of the left side of the bounding rectangle. +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                        public int Left
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                        System.Int32
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Right

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +Gets or sets the width, in integers, of the right side of the bounding rectangle. +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                        public int Right
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                        System.Int32
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Top

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +Gets or sets the width, in integers, of the upper side of the bounding rectangle. +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                        public int Top
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                        System.Int32
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                        ToString()

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Returns the fully qualified type name of this instance.
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                        public override string ToString()
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                        System.StringThe fully qualified type name.
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        System.ValueType.ToString()
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TimeField.html b/docs/api/Terminal.Gui/Terminal.Gui.TimeField.html new file mode 100644 index 0000000000..2e9b2c7601 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TimeField.html @@ -0,0 +1,1007 @@ + + + + + + + + Class TimeField + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                          Class TimeField +

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +Time editing View +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Responder
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          View
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          TextField
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          TimeField
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Implements
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          System.IDisposable
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          + View.Data +
                                                                                                                                                                                                                                                                          + + + + + +
                                                                                                                                                                                                                                                                          + View.Id +
                                                                                                                                                                                                                                                                          + + + + + +
                                                                                                                                                                                                                                                                          + View.X +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + View.Y +
                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                          public class TimeField : TextField, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Remarks
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +The TimeField View provides time editing functionality with mouse support. +
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Constructors +

                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                          TimeField()

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +Initializes a new instance of TimeField using Computed positioning. +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                          public TimeField()
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                          TimeField(Int32, Int32, TimeSpan, Boolean)

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +Initializes a new instance of TimeField using Absolute positioning. +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                          public TimeField(int x, int y, TimeSpan time, bool isShort = false)
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                          System.Int32xThe x coordinate.
                                                                                                                                                                                                                                                                          System.Int32yThe y coordinate.
                                                                                                                                                                                                                                                                          System.TimeSpantimeInitial time.
                                                                                                                                                                                                                                                                          System.BooleanisShortIf true, the seconds are hidden. Sets the IsShortFormat property.
                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                          TimeField(TimeSpan)

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +Initializes a new instance of TimeField using Computed positioning. +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                          public TimeField(TimeSpan time)
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                          System.TimeSpantimeInitial time
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Properties +

                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                          CursorPosition

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                          public override int CursorPosition { get; set; }
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                          System.Int32
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                          IsShortFormat

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +Get or sets whether TimeField uses the short or long time format. +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                          public bool IsShortFormat { get; set; }
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                          Time

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +Gets or sets the time of the TimeField. +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                          public TimeSpan Time { get; set; }
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                          System.TimeSpan
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Remarks
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                          DeleteCharLeft(Boolean)

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                          public override void DeleteCharLeft(bool useOldCursorPos = true)
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                          System.BooleanuseOldCursorPos
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                          DeleteCharRight()

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                          public override void DeleteCharRight()
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                          MouseEvent(MouseEvent)

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                          public override bool MouseEvent(MouseEvent ev)
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                          MouseEventev
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                          OnTimeChanged(DateTimeEventArgs<TimeSpan>)

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +Event firing method that invokes the TimeChanged event. +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                          public virtual void OnTimeChanged(DateTimeEventArgs<TimeSpan> args)
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                          DateTimeEventArgs<System.TimeSpan>argsThe event arguments
                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                          ProcessKey(KeyEvent)

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                          public override bool ProcessKey(KeyEvent kb)
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                          KeyEventkb
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                          Events +

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          TimeChanged

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +TimeChanged event, raised when the Date has changed. +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                          public event Action<DateTimeEventArgs<TimeSpan>> TimeChanged
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Event Type
                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                          System.Action<DateTimeEventArgs<System.TimeSpan>>
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Remarks
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +This event is raised when the Time changes. +
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Implements

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + System.IDisposable +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Toplevel.html b/docs/api/Terminal.Gui/Terminal.Gui.Toplevel.html new file mode 100644 index 0000000000..15b6fd321d --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Toplevel.html @@ -0,0 +1,1791 @@ + + + + + + + + Class Toplevel + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                            Class Toplevel +

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Toplevel views can be modally executed. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Responder
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            View
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Toplevel
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Border.ToplevelContainer
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Window
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Implements
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            System.IDisposable
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            + View.Data +
                                                                                                                                                                                                                                                                            + + + + + +
                                                                                                                                                                                                                                                                            + View.Id +
                                                                                                                                                                                                                                                                            + + + + + + +
                                                                                                                                                                                                                                                                            + View.X +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + View.Y +
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            + View.Text +
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public class Toplevel : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Remarks
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            + Toplevels can be modally executing views, started by calling Run(Toplevel, Func<Exception, Boolean>). + They return control to the caller when RequestStop(Toplevel) has + been called (which sets the Running property to false). +

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            + A Toplevel is created when an application initializes Terminal.Gui by calling Init(ConsoleDriver, IMainLoopDriver). + The application Toplevel can be accessed via Top. Additional Toplevels can be created + and run (e.g. Dialogs. To run a Toplevel, create the Toplevel and + call Run(Toplevel, Func<Exception, Boolean>). +

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            + Toplevels can also opt-in to more sophisticated initialization + by implementing System.ComponentModel.ISupportInitialize. When they do + so, the System.ComponentModel.ISupportInitialize.BeginInit() and +System.ComponentModel.ISupportInitialize.EndInit() methods will be called +before running the view. +If first-run-only initialization is preferred, the System.ComponentModel.ISupportInitializeNotification +can be implemented too, in which case the System.ComponentModel.ISupportInitialize +methods will only be called if System.ComponentModel.ISupportInitializeNotification.IsInitialized +is false. This allows proper View inheritance hierarchies +to override base class layout code optimally by doing so only on first run, +instead of on every run. +

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Constructors +

                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            Toplevel()

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Initializes a new instance of the Toplevel class with Computed layout, defaulting to full screen. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public Toplevel()
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            Toplevel(Rect)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Initializes a new instance of the Toplevel class with the specified absolute layout. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public Toplevel(Rect frame)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            RectframeA superview-relative rectangle specifying the location and size for the new Toplevel
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Properties +

                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            CanFocus

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Gets or sets a value indicating whether this Toplevel can focus. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public override bool CanFocus { get; }
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Booleantrue if can focus; otherwise, false.
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                            IsMdiChild

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Gets or sets if this Toplevel is a Mdi child. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public bool IsMdiChild { get; }
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            IsMdiContainer

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Gets or sets if this Toplevel is a Mdi container. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public bool IsMdiContainer { get; set; }
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            MenuBar

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Gets or sets the menu for this Toplevel +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public virtual MenuBar MenuBar { get; set; }
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            MenuBar
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            Modal

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Determines whether the Toplevel is modal or not. +Causes ProcessKey(KeyEvent) to propagate keys upwards +by default unless set to true. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public bool Modal { get; set; }
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            Running

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Gets or sets whether the MainLoop for this Toplevel is running or not. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public bool Running { get; set; }
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Remarks
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Setting this property directly is discouraged. Use RequestStop(Toplevel) instead. +
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            StatusBar

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Gets or sets the status bar for this Toplevel +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public virtual StatusBar StatusBar { get; set; }
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            StatusBar
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            Add(View)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public override void Add(View view)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            Viewview
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                            Create()

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Convenience factory method that creates a new Toplevel with the current terminal dimensions. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public static Toplevel Create()
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            ToplevelThe create.
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            GetTopMdiChild(Type, String[])

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Gets the current visible toplevel Mdi child that match the arguments pattern. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public View GetTopMdiChild(Type type = null, string[] exclude = null)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            System.TypetypeThe type.
                                                                                                                                                                                                                                                                            System.String[]excludeThe strings to exclude.
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            ViewThe matched view.
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            MouseEvent(MouseEvent)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public override bool MouseEvent(MouseEvent mouseEvent)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            MouseEventmouseEvent
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                            MoveNext()

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Move to the next Mdi child from the MdiTop. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public virtual void MoveNext()
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            MovePrevious()

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Move to the previous Mdi child from the MdiTop. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public virtual void MovePrevious()
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            OnAlternateBackwardKeyChanged(Key)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Virtual method to invoke the AlternateBackwardKeyChanged event. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public virtual void OnAlternateBackwardKeyChanged(Key oldKey)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            KeyoldKey
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            OnAlternateForwardKeyChanged(Key)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Virtual method to invoke the AlternateForwardKeyChanged event. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public virtual void OnAlternateForwardKeyChanged(Key oldKey)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            KeyoldKey
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            OnKeyDown(KeyEvent)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public override bool OnKeyDown(KeyEvent keyEvent)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            KeyEventkeyEvent
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                            OnKeyUp(KeyEvent)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public override bool OnKeyUp(KeyEvent keyEvent)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            KeyEventkeyEvent
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                            OnLoaded()

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Called from Begin(Toplevel) before the Toplevel is redraws for the first time. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public virtual void OnLoaded()
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            OnQuitKeyChanged(Key)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Virtual method to invoke the QuitKeyChanged event. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public virtual void OnQuitKeyChanged(Key oldKey)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            KeyoldKey
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            PositionCursor()

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public override void PositionCursor()
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                            PositionToplevel(Toplevel)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Virtual method which allow to be overridden to implement specific positions for inherited Toplevel. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public virtual void PositionToplevel(Toplevel top)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            TopleveltopThe toplevel.
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            ProcessColdKey(KeyEvent)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public override bool ProcessColdKey(KeyEvent keyEvent)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            KeyEventkeyEvent
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                            ProcessKey(KeyEvent)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public override bool ProcessKey(KeyEvent keyEvent)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            KeyEventkeyEvent
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                            Redraw(Rect)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public override void Redraw(Rect bounds)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            Rectbounds
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                            Remove(View)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public override void Remove(View view)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            Viewview
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                            RemoveAll()

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public override void RemoveAll()
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                            RequestStop()

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Stops running this Toplevel. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public virtual void RequestStop()
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            RequestStop(Toplevel)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Stops running the top Toplevel. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public virtual void RequestStop(Toplevel top)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            TopleveltopThe toplevel to request stop.
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            ShowChild(Toplevel)

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Shows the Mdi child indicated by the top setting as Current. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public virtual bool ShowChild(Toplevel top = null)
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                            TopleveltopThe toplevel.
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Booleantrue if the toplevel can be showed.false otherwise.
                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                            WillPresent()

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Invoked by Begin(Toplevel) as part of the Run(Toplevel, Func<Exception, Boolean>) after +the views have been laid out, and before the views are drawn for the first time. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public virtual void WillPresent()
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Events +

                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Activate

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Invoked once the Toplevel's Application.RunState becomes the Current. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action<Toplevel> Activate
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action<Toplevel>
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            AllChildClosed

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Invoked once the last child Toplevel's Application.RunState is closed from the Terminal.Gui.Application.End(Terminal.Gui.View) +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action AllChildClosed
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            AlternateBackwardKeyChanged

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Invoked when the AlternateBackwardKey is changed. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action<Key> AlternateBackwardKeyChanged
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action<Key>
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            AlternateForwardKeyChanged

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Invoked when the AlternateForwardKey is changed. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action<Key> AlternateForwardKeyChanged
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action<Key>
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            ChildClosed

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Invoked once the child Toplevel's Application.RunState is closed from the Terminal.Gui.Application.End(Terminal.Gui.View) +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action<Toplevel> ChildClosed
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action<Toplevel>
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            ChildLoaded

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Invoked once the child Toplevel's Application.RunState has begin loaded. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action<Toplevel> ChildLoaded
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action<Toplevel>
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            ChildUnloaded

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Invoked once the child Toplevel's Application.RunState has begin unloaded. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action<Toplevel> ChildUnloaded
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action<Toplevel>
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Closed

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Invoked once the Toplevel's Application.RunState is closed from the Terminal.Gui.Application.End(Terminal.Gui.View) +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action<Toplevel> Closed
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action<Toplevel>
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Closing

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Invoked once the Toplevel's Application.RunState is being closing from the RequestStop(Toplevel) +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action<ToplevelClosingEventArgs> Closing
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action<ToplevelClosingEventArgs>
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Deactivate

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Invoked once the Toplevel's Application.RunState ceases to be the Current. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action<Toplevel> Deactivate
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action<Toplevel>
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Loaded

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Fired once the Toplevel's Application.RunState has begin loaded. +A Loaded event handler is a good place to finalize initialization before calling `RunLoop(Application.RunState, Boolean). +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action Loaded
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            QuitKeyChanged

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Invoked when the QuitKey is changed. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action<Key> QuitKeyChanged
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action<Key>
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Ready

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Fired once the Toplevel's MainLoop has started it's first iteration. +Subscribe to this event to perform tasks when the Toplevel has been laid out and focus has been set. +changes. A Ready event handler is a good place to finalize initialization after calling `Run(Func<Exception, Boolean>)(topLevel)`. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action Ready
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Resized

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Invoked when the terminal was resized. The new Size of the terminal is provided. +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action<Size> Resized
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action<Size>
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Unloaded

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +Fired once the Toplevel's Application.RunState has begin unloaded. +A Unloaded event handler is a good place to disposing after calling `End(Application.RunState). +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                            public event Action Unloaded
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                            System.Action
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + System.IDisposable +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ToplevelClosingEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.ToplevelClosingEventArgs.html new file mode 100644 index 0000000000..501c90286d --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ToplevelClosingEventArgs.html @@ -0,0 +1,242 @@ + + + + + + + + Class ToplevelClosingEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                              Class ToplevelClosingEventArgs +

                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +System.EventArgs implementation for the Closing event. +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Inheritance
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              System.EventArgs
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              ToplevelClosingEventArgs
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + System.EventArgs.Empty +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + System.Object.ToString() +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                              public class ToplevelClosingEventArgs : EventArgs
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Constructors +

                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                              ToplevelClosingEventArgs(Toplevel)

                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +Initializes the event arguments with the requesting toplevel. +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                              public ToplevelClosingEventArgs(Toplevel requestingTop)
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                              ToplevelrequestingTopThe RequestingTop.
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Properties +

                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                              Cancel

                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +Provides an event cancellation option. +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                              public bool Cancel { get; set; }
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                              System.Boolean
                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                              RequestingTop

                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +The toplevel requesting stop. +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                              public View RequestingTop { get; }
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                              View
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ToplevelComparer.html b/docs/api/Terminal.Gui/Terminal.Gui.ToplevelComparer.html new file mode 100644 index 0000000000..9158a000ae --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ToplevelComparer.html @@ -0,0 +1,215 @@ + + + + + + + + Class ToplevelComparer + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                Class ToplevelComparer +

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +Implements the System.Collections.Generic.IComparer<T> to sort the Toplevel from the MdiChildes if needed. +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                ToplevelComparer
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                Implements
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                System.Collections.Generic.IComparer<Toplevel>
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + System.Object.ToString() +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                public sealed class ToplevelComparer : IComparer<Toplevel>
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Methods +

                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                Compare(Toplevel, Toplevel)

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other.
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                public int Compare(Toplevel x, Toplevel y)
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                ToplevelxThe first object to compare.
                                                                                                                                                                                                                                                                                ToplevelyThe second object to compare.
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                System.Int32A signed integer that indicates the relative values of x and y, as shown in the following table.Value Meaning Less than zero +x is less than y.Zero +x equals y.Greater than zero +x is greater than y.
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Implements

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + System.Collections.Generic.IComparer<T> +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ToplevelEqualityComparer.html b/docs/api/Terminal.Gui/Terminal.Gui.ToplevelEqualityComparer.html new file mode 100644 index 0000000000..ae940b0929 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.ToplevelEqualityComparer.html @@ -0,0 +1,268 @@ + + + + + + + + Class ToplevelEqualityComparer + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                  Class ToplevelEqualityComparer +

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +Implements the System.Collections.Generic.IEqualityComparer<T> to comparing two Toplevel used by StackExtensions. +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  ToplevelEqualityComparer
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Implements
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  System.Collections.Generic.IEqualityComparer<Toplevel>
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + System.Object.ToString() +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                  public class ToplevelEqualityComparer : IEqualityComparer<Toplevel>
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Methods +

                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                  Equals(Toplevel, Toplevel)

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Determines whether the specified objects are equal.
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                  public bool Equals(Toplevel x, Toplevel y)
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                                                                                                  ToplevelxThe first object of type Toplevel to compare.
                                                                                                                                                                                                                                                                                  ToplevelyThe second object of type Toplevel to compare.
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Returns
                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                  System.Boolean +true if the specified objects are equal; otherwise, false.
                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                  GetHashCode(Toplevel)

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Returns a hash code for the specified object.
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                  public int GetHashCode(Toplevel obj)
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                                                                                                  ToplevelobjThe Toplevel for which a hash code is to be returned.
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Returns
                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                  System.Int32A hash code for the specified object.
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Exceptions
                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                  TypeCondition
                                                                                                                                                                                                                                                                                  System.ArgumentNullExceptionThe type of obj is a reference type and obj is null.
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Implements

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + System.Collections.Generic.IEqualityComparer<T> +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TreeView-1.html b/docs/api/Terminal.Gui/Terminal.Gui.TreeView-1.html new file mode 100644 index 0000000000..b8e3cdfe7d --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TreeView-1.html @@ -0,0 +1,2400 @@ + + + + + + + + Class TreeView<T> + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                    Class TreeView<T> +

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Hierarchical tree view with expandable branches. Branch objects are dynamically determined +when expanded using a user defined ITreeBuilder<T> + +See TreeView Deep Dive for more information. +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Responder
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    View
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    TreeView<T>
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    TreeView
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    System.IDisposable
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    + View.Data +
                                                                                                                                                                                                                                                                                    + + + + + + +
                                                                                                                                                                                                                                                                                    + View.Id +
                                                                                                                                                                                                                                                                                    + + + + + + +
                                                                                                                                                                                                                                                                                    + View.X +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + View.Y +
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    + View.Text +
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public class TreeView<T> : View, IDisposable, ISupportInitializeNotification, ISupportInitialize, ITreeView where T : class
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Type Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    NameDescription
                                                                                                                                                                                                                                                                                    T
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Constructors +

                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    TreeView()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Creates a new tree view with absolute positioning. +Use AddObjects(IEnumerable<T>) to set set root objects for the tree. +Children will not be rendered until you set TreeBuilder +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public TreeView()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    TreeView(ITreeBuilder<T>)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Initialises TreeBuilder.Creates a new tree view with absolute +positioning. Use AddObjects(IEnumerable<T>) to set set root +objects for the tree. +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public TreeView(ITreeBuilder<T> builder)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    ITreeBuilder<T>builder
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Fields +

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    NoBuilderError

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Error message to display when the control is not properly initialized at draw time +(nodes added but no tree builder set) +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public static ustring NoBuilderError
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Field Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    NStack.ustring
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Properties +

                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    AllowLetterBasedNavigation

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +True makes a letter key press navigate to the next visible branch that begins with +that letter/digit +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public bool AllowLetterBasedNavigation { get; set; }
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    AspectGetter

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Returns the string representation of model objects hosted in the tree. Default +implementation is to call System.Object.ToString() +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public AspectGetterDelegate<T> AspectGetter { get; set; }
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    AspectGetterDelegate<T>
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    ColorGetter

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Delegate for multi colored tree views. Return the ColorScheme to use +for each passed object or null to use the default. +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public Func<T, ColorScheme> ColorGetter { get; set; }
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Func<T, ColorScheme>
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    ContentHeight

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +The current number of rows in the tree (ignoring the controls bounds) +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public int ContentHeight { get; }
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    DesiredCursorVisibility

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Get / Set the wished cursor when the tree is focused +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public CursorVisibility DesiredCursorVisibility { get; set; }
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    CursorVisibility
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    MultiSelect

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +True to allow multiple objects to be selected at once +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public bool MultiSelect { get; set; }
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    ObjectActivationButton

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Mouse event to trigger ObjectActivated. +Defaults to double click (Button1DoubleClicked). +Set to null to disable this feature. +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public MouseFlags? ObjectActivationButton { get; set; }
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Nullable<MouseFlags>
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    ObjectActivationKey

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Key which when pressed triggers ObjectActivated. +Defaults to Enter +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public Key ObjectActivationKey { get; set; }
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    Key
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    Objects

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +The root objects in the tree, note that this collection is of root objects only +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public IEnumerable<T> Objects { get; }
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Collections.Generic.IEnumerable<T>
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    ScrollOffsetHorizontal

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +The amount of tree view that has been scrolled to the right (horizontally) +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public int ScrollOffsetHorizontal { get; set; }
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Setting a value of less than 0 will result in a offset of 0. To see changes +in the UI call SetNeedsDisplay()
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    ScrollOffsetVertical

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +The amount of tree view that has been scrolled off the top of the screen (by the user +scrolling down) +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public int ScrollOffsetVertical { get; set; }
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Setting a value of less than 0 will result in a offset of 0. To see changes +in the UI call SetNeedsDisplay()
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    SelectedObject

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +The currently selected object in the tree. When MultiSelect is true this +is the object at which the cursor is at +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public T SelectedObject { get; set; }
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    T
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    Style

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Contains options for changing how the tree is rendered +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public TreeStyle Style { get; set; }
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    TreeStyle
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    TreeBuilder

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Determines how sub branches of the tree are dynamically built at runtime as the user +expands root nodes +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public ITreeBuilder<T> TreeBuilder { get; set; }
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    ITreeBuilder<T>
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    ActivateSelectedObjectIfAny()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Triggers the ObjectActivated event with the SelectedObject.

                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    This method also ensures that the selected object is visible

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void ActivateSelectedObjectIfAny()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    AddObject(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Adds a new root level object unless it is already a root of the tree +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void AddObject(T o)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    To
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    AddObjects(IEnumerable<T>)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Adds many new root level objects. Objects that are already root objects are ignored +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void AddObjects(IEnumerable<T> collection)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    System.Collections.Generic.IEnumerable<T>collectionObjects to add as new root level objects
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    AdjustSelection(Int32, Boolean)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +The number of screen lines to move the currently selected object by. Supports negative +offset. Each branch occupies 1 line on screen +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void AdjustSelection(int offset, bool expandSelection = false)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    System.Int32offsetPositive to move the selection down the screen, negative to move it up
                                                                                                                                                                                                                                                                                    System.BooleanexpandSelectionTrue to expand the selection (assuming +MultiSelect is enabled). False to replace
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    If nothing is currently selected or the selected object is no longer in the tree +then the first object in the tree is selected instead
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    AdjustSelectionToBranchEnd()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Moves the selection to the last child in the currently selected level +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void AdjustSelectionToBranchEnd()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    AdjustSelectionToBranchStart()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Moves the selection to the first child in the currently selected level +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void AdjustSelectionToBranchStart()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    AdjustSelectionToNextItemBeginningWith(Char, StringComparison)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Moves the SelectedObject to the next item that begins with character

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    This method will loop back to the start of the tree if reaching the end without finding a match

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void AdjustSelectionToNextItemBeginningWith(char character, StringComparison caseSensitivity = StringComparison.CurrentCultureIgnoreCase)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    System.CharcharacterThe first character of the next item you want selected
                                                                                                                                                                                                                                                                                    System.StringComparisoncaseSensitivityCase sensitivity of the search
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    CanExpand(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Returns true if the given object o is exposed in the tree and can be +expanded otherwise false +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public bool CanExpand(T o)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    To
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    ClearObjects()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Removes all objects from the tree and clears SelectedObject +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void ClearObjects()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    Collapse()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Collapses the SelectedObject +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void Collapse()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    Collapse(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Collapses the supplied object if it is currently expanded +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void Collapse(T toCollapse)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    TtoCollapseThe object to collapse
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    CollapseAll()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Collapses all root nodes in the tree +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void CollapseAll()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    CollapseAll(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Collapses the supplied object if it is currently expanded. Also collapses all children +branches (this will only become apparent when/if the user expands it again) +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void CollapseAll(T toCollapse)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    TtoCollapseThe object to collapse
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    CollapseImpl(T, Boolean)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Implementation of Collapse(T) and CollapseAll(T). Performs +operation and updates selection if disapeared +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    protected void CollapseImpl(T toCollapse, bool all)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    TtoCollapse
                                                                                                                                                                                                                                                                                    System.Booleanall
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    CursorLeft(Boolean)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Determines systems behaviour when the left arrow key is pressed. Default behaviour is +to collapse the current tree node if possible otherwise changes selection to current +branches parent +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    protected virtual void CursorLeft(bool ctrl)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    System.Booleanctrl
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    EnsureVisible(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Adjusts the ScrollOffsetVertical to ensure the given +model is visible. Has no effect if already visible +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void EnsureVisible(T model)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    Tmodel
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    Expand()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Expands the currently SelectedObject +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void Expand()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    Expand(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Expands the supplied object if it is contained in the tree (either as a root object or +as an exposed branch object) +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void Expand(T toExpand)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    TtoExpandThe object to expand
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    ExpandAll()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Fully expands all nodes in the tree, if the tree is very big and built dynamically this +may take a while (e.g. for file system) +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void ExpandAll()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    ExpandAll(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Expands the supplied object and all child objects +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void ExpandAll(T toExpand)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    TtoExpandThe object to expand
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    GetAllSelectedObjects()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Returns SelectedObject (if not null) and all multi selected objects if +MultiSelect is true +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public IEnumerable<T> GetAllSelectedObjects()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Collections.Generic.IEnumerable<T>
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    GetChildren(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Returns the currently expanded children of the passed object. Returns an empty +collection if the branch is not exposed or not expanded +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public IEnumerable<T> GetChildren(T o)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    ToAn object in the tree
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Collections.Generic.IEnumerable<T>
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    GetContentWidth(Boolean)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Returns the maximum width line in the tree including prefix and expansion symbols +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public int GetContentWidth(bool visible)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    System.BooleanvisibleTrue to consider only rows currently visible (based on window + bounds and ScrollOffsetVertical. False to calculate the width of +every exposed branch in the tree
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Int32
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    GetObjectOnRow(Int32)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Returns the object in the tree list that is currently visible +at the provided row. Returns null if no object is at that location. + + +If you have screen coordinates then use ScreenToView(Int32, Int32) +to translate these into the client area of the TreeView<T>. +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public T GetObjectOnRow(int row)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    System.Int32rowThe row of the Bounds of the TreeView<T>
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    TThe object currently displayed on this row or null
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    GetObjectRow(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    +Returns the Y coordinate within the Bounds of the +tree at which toFind would be displayed or null if +it is not currently exposed (e.g. its parent is collapsed). +

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    +Note that the returned value can be negative if the TreeView is scrolled +down and the toFind object is off the top of the view. +

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public int? GetObjectRow(T toFind)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    TtoFind
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Nullable<System.Int32>
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    GetParent(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Returns the parent object of o in the tree. Returns null if +the object is not exposed in the tree +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public T GetParent(T o)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    ToAn object in the tree
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    T
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    GetScrollOffsetOf(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Returns the index of the object o if it is currently exposed (it's +parent(s) have been expanded). This can be used with ScrollOffsetVertical +and SetNeedsDisplay() to scroll to a specific object +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public int GetScrollOffsetOf(T o)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    ToAn object that appears in your tree and is currently exposed
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Int32The index the object was found at or -1 if it is not currently revealed or +not in the tree at all
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Uses the Equals method and returns the first index at which the object is found + or -1 if it is not found
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    GoTo(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Changes the SelectedObject to toSelect and scrolls to ensure +it is visible. Has no effect if toSelect is not exposed in the tree (e.g. +its parents are collapsed) +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void GoTo(T toSelect)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    TtoSelect
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    GoToEnd()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Changes the SelectedObject to the last object in the tree and scrolls so +that it is visible +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void GoToEnd()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    GoToFirst()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Changes the SelectedObject to the first root object and resets +the ScrollOffsetVertical to 0 +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void GoToFirst()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    InvalidateLineMap()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Clears any cached results of Terminal.Gui.TreeView`1.BuildLineMap +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    protected void InvalidateLineMap()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    IsExpanded(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Returns true if the given object o is exposed in the tree and +expanded otherwise false +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public bool IsExpanded(T o)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    To
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    IsSelected(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Returns true if the model is either the +SelectedObject or part of a MultiSelect +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public bool IsSelected(T model)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    Tmodel
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    MouseEvent(MouseEvent)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public override bool MouseEvent(MouseEvent me)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    MouseEventme
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                    MovePageDown(Boolean)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Moves the selection down by the height of the control (1 page). +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void MovePageDown(bool expandSelection = false)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    System.BooleanexpandSelectionTrue if the navigation should add the covered nodes to the selected current selection
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Exceptions
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeCondition
                                                                                                                                                                                                                                                                                    System.NotImplementedException
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    MovePageUp(Boolean)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Moves the selection up by the height of the control (1 page). +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void MovePageUp(bool expandSelection = false)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    System.BooleanexpandSelectionTrue if the navigation should add the covered nodes to the selected current selection
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Exceptions
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeCondition
                                                                                                                                                                                                                                                                                    System.NotImplementedException
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    OnEnter(View)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public override bool OnEnter(View view)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    Viewview
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                    OnObjectActivated(ObjectActivatedEventArgs<T>)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Raises the ObjectActivated event +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    protected virtual void OnObjectActivated(ObjectActivatedEventArgs<T> e)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    ObjectActivatedEventArgs<T>e
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    OnSelectionChanged(SelectionChangedEventArgs<T>)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Raises the SelectionChanged event +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    protected virtual void OnSelectionChanged(SelectionChangedEventArgs<T> e)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    SelectionChangedEventArgs<T>e
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    PositionCursor()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Positions the cursor at the start of the selected objects line (if visible) +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public override void PositionCursor()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                    ProcessKey(KeyEvent)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public override bool ProcessKey(KeyEvent keyEvent)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    KeyEventkeyEvent
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                    RebuildTree()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Rebuilds the tree structure for all exposed objects starting with the root objects. +Call this method when you know there are changes to the tree but don't know which +objects have changed (otherwise use RefreshObject(T, Boolean)) +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void RebuildTree()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    Redraw(Rect)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public override void Redraw(Rect bounds)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    Rectbounds
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                    RefreshObject(T, Boolean)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Refreshes the state of the object o in the tree. This will +recompute children, string representation etc +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void RefreshObject(T o, bool startAtTop = false)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    To
                                                                                                                                                                                                                                                                                    System.BooleanstartAtTopTrue to also refresh all ancestors of the objects branch +(starting with the root). False to refresh only the passed node
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    This has no effect if the object is not exposed in the tree.
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    Remove(T)

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Removes the given root object from the tree +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void Remove(T o)
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                    To
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    If o is the currently SelectedObject then the +selection is cleared
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    ScrollDown()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Scrolls the view area down a single line without changing the current selection +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void ScrollDown()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    ScrollUp()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Scrolls the view area up a single line without changing the current selection +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void ScrollUp()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    SelectAll()

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Selects all objects in the tree when MultiSelect is enabled otherwise +does nothing +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public void SelectAll()
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Events +

                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    ObjectActivated

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +This event is raised when an object is activated e.g. by double clicking or +pressing ObjectActivationKey +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public event Action<ObjectActivatedEventArgs<T>> ObjectActivated
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Event Type
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.Action<ObjectActivatedEventArgs<T>>
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    SelectionChanged

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +Called when the SelectedObject changes +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                    public event EventHandler<SelectionChangedEventArgs<T>> SelectionChanged
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Event Type
                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                    System.EventHandler<SelectionChangedEventArgs<T>>
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + System.IDisposable +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + ITreeView +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TreeView.html b/docs/api/Terminal.Gui/Terminal.Gui.TreeView.html new file mode 100644 index 0000000000..8819605200 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.TreeView.html @@ -0,0 +1,793 @@ + + + + + + + + Class TreeView + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                      Class TreeView +

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +Convenience implementation of generic TreeView<T> for any tree were all nodes +implement ITreeNode. + +See TreeView Deep Dive for more information. +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Responder
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      View
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      TreeView<ITreeNode>
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      TreeView
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Implements
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      System.IDisposable
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                      + View.Data +
                                                                                                                                                                                                                                                                                      + + + + + + +
                                                                                                                                                                                                                                                                                      + View.Id +
                                                                                                                                                                                                                                                                                      + + + + + + +
                                                                                                                                                                                                                                                                                      + View.X +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + View.Y +
                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                      + View.Text +
                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                      public class TreeView : TreeView<ITreeNode>, IDisposable, ISupportInitializeNotification, ISupportInitialize, ITreeView
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Constructors +

                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                      TreeView()

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +Creates a new instance of the tree control with absolute positioning and initialises +TreeBuilder<T> with default ITreeNode based builder +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                      public TreeView()
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + System.IDisposable +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + ITreeView +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Trees.AspectGetterDelegate-1.html b/docs/api/Terminal.Gui/Terminal.Gui.Trees.AspectGetterDelegate-1.html new file mode 100644 index 0000000000..8b1ef2180c --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Trees.AspectGetterDelegate-1.html @@ -0,0 +1,177 @@ + + + + + + + + Delegate AspectGetterDelegate<T> + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                        Delegate AspectGetterDelegate<T> +

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +Delegates of this type are used to fetch string representations of user's model objects +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        Namespace: Terminal.Gui.Trees
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                        public delegate string AspectGetterDelegate<T>(T toRender)
+
+    where T : class;
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                        TtoRenderThe object that is being rendered
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                        System.String
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        Type Parameters
                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                        NameDescription
                                                                                                                                                                                                                                                                                        T
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Trees.DelegateTreeBuilder-1.html b/docs/api/Terminal.Gui/Terminal.Gui.Trees.DelegateTreeBuilder-1.html new file mode 100644 index 0000000000..d44149ac27 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Trees.DelegateTreeBuilder-1.html @@ -0,0 +1,338 @@ + + + + + + + + Class DelegateTreeBuilder<T> + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                          Class DelegateTreeBuilder<T> +

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +Implementation of ITreeBuilder<T> that uses user defined functions +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          TreeBuilder<T>
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          DelegateTreeBuilder<T>
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Implements
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + System.Object.ToString() +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Namespace: Terminal.Gui.Trees
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                          public class DelegateTreeBuilder<T> : TreeBuilder<T>, ITreeBuilder<T>
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Type Parameters
                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                          NameDescription
                                                                                                                                                                                                                                                                                          T
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Constructors +

                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                          DelegateTreeBuilder(Func<T, IEnumerable<T>>)

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +Constructs an implementation of ITreeBuilder<T> that calls the user +defined method childGetter to determine children +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                          public DelegateTreeBuilder(Func<T, IEnumerable<T>> childGetter)
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                                          System.Func<T, System.Collections.Generic.IEnumerable<T>>childGetter
                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                          DelegateTreeBuilder(Func<T, IEnumerable<T>>, Func<T, Boolean>)

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +Constructs an implementation of ITreeBuilder<T> that calls the user +defined method childGetter to determine children +and canExpand to determine expandability +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                          public DelegateTreeBuilder(Func<T, IEnumerable<T>> childGetter, Func<T, bool> canExpand)
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                                          System.Func<T, System.Collections.Generic.IEnumerable<T>>childGetter
                                                                                                                                                                                                                                                                                          System.Func<T, System.Boolean>canExpand
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                          CanExpand(T)

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +Returns whether a node can be expanded based on the delegate passed during construction +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                          public override bool CanExpand(T toExpand)
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                                          TtoExpand
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Terminal.Gui.Trees.TreeBuilder<T>.CanExpand(T)
                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                          GetChildren(T)

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +Returns children using the delegate method passed during construction +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                          public override IEnumerable<T> GetChildren(T forObject)
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                                          TforObject
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                          System.Collections.Generic.IEnumerable<T>
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Terminal.Gui.Trees.TreeBuilder<T>.GetChildren(T)
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Implements

                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Trees.ITreeBuilder-1.html b/docs/api/Terminal.Gui/Terminal.Gui.Trees.ITreeBuilder-1.html new file mode 100644 index 0000000000..e70b5eb861 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Trees.ITreeBuilder-1.html @@ -0,0 +1,265 @@ + + + + + + + + Interface ITreeBuilder<T> + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                            Interface ITreeBuilder<T> +

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +Interface for supplying data to a TreeView<T> on demand as root level nodes +are expanded by the user +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Namespace: Terminal.Gui.Trees
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                            public interface ITreeBuilder<T>
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Type Parameters
                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                            NameDescription
                                                                                                                                                                                                                                                                                            T
                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Properties +

                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                            SupportsCanExpand

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +Returns true if CanExpand(T) is implemented by this class +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                            bool SupportsCanExpand { get; }
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                            CanExpand(T)

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +Returns true/false for whether a model has children. This method should be implemented +when GetChildren(T) is an expensive operation otherwise +SupportsCanExpand should return false (in which case this method will not +be called) +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                            bool CanExpand(T toExpand)
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                            TtoExpand
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                            System.Boolean
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Remarks
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Only implement this method if you have a very fast way of determining whether +an object can have children e.g. checking a Type (directories can always be expanded) +
                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                            GetChildren(T)

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +Returns all children of a given forObject which should be added to the +tree as new branches underneath it +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                            IEnumerable<T> GetChildren(T forObject)
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                            TforObject
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                            System.Collections.Generic.IEnumerable<T>
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Trees.ITreeNode.html b/docs/api/Terminal.Gui/Terminal.Gui.Trees.ITreeNode.html new file mode 100644 index 0000000000..360d8e5905 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Trees.ITreeNode.html @@ -0,0 +1,207 @@ + + + + + + + + Interface ITreeNode + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                                              Interface ITreeNode +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +Interface to implement when you want the regular (non generic) TreeView +to automatically determine children for your class (without having to specify +an ITreeBuilder<T>) +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Namespace: Terminal.Gui.Trees
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                              public interface ITreeNode
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Properties +

                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                              Children

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +The children of your class which should be rendered underneath it when expanded +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                              IList<ITreeNode> Children { get; }
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                              System.Collections.Generic.IList<ITreeNode>
                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                              Tag

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +Optionally allows you to store some custom data/class here. +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                              object Tag { get; set; }
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                              Text

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +Text to display when rendering the node +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                              string Text { get; set; }
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                              System.String
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Trees.ObjectActivatedEventArgs-1.html b/docs/api/Terminal.Gui/Terminal.Gui.Trees.ObjectActivatedEventArgs-1.html new file mode 100644 index 0000000000..4a0f2621e1 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Trees.ObjectActivatedEventArgs-1.html @@ -0,0 +1,260 @@ + + + + + + + + Class ObjectActivatedEventArgs<T> + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                Class ObjectActivatedEventArgs<T> +

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +Event args for the ObjectActivated event +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                ObjectActivatedEventArgs<T>
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                Namespace: Terminal.Gui.Trees
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                public class ObjectActivatedEventArgs<T>
+
+    where T : class
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                Type Parameters
                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                NameDescription
                                                                                                                                                                                                                                                                                                T
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                Constructors +

                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                ObjectActivatedEventArgs(TreeView<T>, T)

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +Creates a new instance documenting activation of the activated object +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                public ObjectActivatedEventArgs(TreeView<T> tree, T activated)
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                TreeView<T>treeTree in which the activation is happening
                                                                                                                                                                                                                                                                                                TactivatedWhat object is being activated
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                Properties +

                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                ActivatedObject

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +The object that was selected at the time of activation +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                public T ActivatedObject { get; }
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                T
                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                Tree

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +The tree in which the activation occurred +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                public TreeView<T> Tree { get; }
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                TreeView<T>
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Trees.SelectionChangedEventArgs-1.html b/docs/api/Terminal.Gui/Terminal.Gui.Trees.SelectionChangedEventArgs-1.html new file mode 100644 index 0000000000..45dfe526c2 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Trees.SelectionChangedEventArgs-1.html @@ -0,0 +1,293 @@ + + + + + + + + Class SelectionChangedEventArgs<T> + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                  Class SelectionChangedEventArgs<T> +

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +Event arguments describing a change in selected object in a tree view +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  System.EventArgs
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  SelectionChangedEventArgs<T>
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + System.EventArgs.Empty +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Namespace: Terminal.Gui.Trees
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                  public class SelectionChangedEventArgs<T> : EventArgs where T : class
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Type Parameters
                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                  NameDescription
                                                                                                                                                                                                                                                                                                  T
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Constructors +

                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                  SelectionChangedEventArgs(TreeView<T>, T, T)

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +Creates a new instance of event args describing a change of selection +in tree +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                  public SelectionChangedEventArgs(TreeView<T> tree, T oldValue, T newValue)
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                                                                                                                  TreeView<T>tree
                                                                                                                                                                                                                                                                                                  ToldValue
                                                                                                                                                                                                                                                                                                  TnewValue
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Properties +

                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                  NewValue

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +The newly selected value in the Tree (can be null) +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                  public T NewValue { get; }
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                                  T
                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                  OldValue

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +The previously selected value (can be null) +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                  public T OldValue { get; }
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                                  T
                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                  Tree

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +The view in which the change occurred +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                  public TreeView<T> Tree { get; }
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                                  TreeView<T>
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeBuilder-1.html b/docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeBuilder-1.html new file mode 100644 index 0000000000..2a3e0c315e --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeBuilder-1.html @@ -0,0 +1,323 @@ + + + + + + + + Class TreeBuilder<T> + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                    Class TreeBuilder<T> +

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +Abstract implementation of ITreeBuilder<T>. +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    TreeBuilder<T>
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    DelegateTreeBuilder<T>
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    TreeNodeBuilder
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Namespace: Terminal.Gui.Trees
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                    public abstract class TreeBuilder<T> : ITreeBuilder<T>
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Type Parameters
                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                    NameDescription
                                                                                                                                                                                                                                                                                                    T
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Constructors +

                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                    TreeBuilder(Boolean)

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +Constructs base and initializes SupportsCanExpand +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                    public TreeBuilder(bool supportsCanExpand)
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                    System.BooleansupportsCanExpandPass true if you intend to +implement CanExpand(T) otherwise false
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Properties +

                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                    SupportsCanExpand

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                    public bool SupportsCanExpand { get; protected set; }
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                    CanExpand(T)

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +Override this method to return a rapid answer as to whether GetChildren(T) +returns results. If you are implementing this method ensure you passed true in base +constructor or set SupportsCanExpand +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                    public virtual bool CanExpand(T toExpand)
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                    TtoExpand
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                    System.Boolean
                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                    GetChildren(T)

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                    public abstract IEnumerable<T> GetChildren(T forObject)
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                    TforObject
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                    System.Collections.Generic.IEnumerable<T>
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeNode.html b/docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeNode.html new file mode 100644 index 0000000000..87dc9a21a7 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeNode.html @@ -0,0 +1,307 @@ + + + + + + + + Class TreeNode + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                      Class TreeNode +

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +Simple class for representing nodes, use with regular (non generic) TreeView. +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      TreeNode
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Implements
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Namespace: Terminal.Gui.Trees
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                      public class TreeNode : ITreeNode
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      Constructors +

                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                      TreeNode()

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +Initialises a new instance with no Text +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                      public TreeNode()
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                      TreeNode(String)

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +Initialises a new instance and sets starting Text +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                      public TreeNode(string text)
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                      System.Stringtext
                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      Properties +

                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                      Children

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +Children of the current node +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                      public virtual IList<ITreeNode> Children { get; set; }
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                      System.Collections.Generic.IList<ITreeNode>
                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                      Tag

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +Optionally allows you to store some custom data/class here. +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                      public object Tag { get; set; }
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                      Text

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +Text to display in tree node for current entry +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                      public virtual string Text { get; set; }
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                      System.String
                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      Methods +

                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                      ToString()

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +returns Text +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                      public override string ToString()
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                      System.String
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      System.Object.ToString()
                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + ITreeNode +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeNodeBuilder.html b/docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeNodeBuilder.html new file mode 100644 index 0000000000..897e966264 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeNodeBuilder.html @@ -0,0 +1,231 @@ + + + + + + + + Class TreeNodeBuilder + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                        Class TreeNodeBuilder +

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +ITreeBuilder<T> implementation for ITreeNode objects +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        TreeBuilder<ITreeNode>
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        TreeNodeBuilder
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Implements
                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Namespace: Terminal.Gui.Trees
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                        public class TreeNodeBuilder : TreeBuilder<ITreeNode>, ITreeBuilder<ITreeNode>
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        Constructors +

                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                        TreeNodeBuilder()

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +Initialises a new instance of builder for any model objects of +Type ITreeNode +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                        public TreeNodeBuilder()
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                        GetChildren(ITreeNode)

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +Returns Children from model +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                        public override IEnumerable<ITreeNode> GetChildren(ITreeNode model)
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                        ITreeNodemodel
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                        System.Collections.Generic.IEnumerable<ITreeNode>
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Terminal.Gui.Trees.TreeBuilder<Terminal.Gui.Trees.ITreeNode>.GetChildren(Terminal.Gui.Trees.ITreeNode)
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeStyle.html b/docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeStyle.html new file mode 100644 index 0000000000..7cc0e0ae76 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Trees.TreeStyle.html @@ -0,0 +1,314 @@ + + + + + + + + Class TreeStyle + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                          Class TreeStyle +

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +Defines rendering options that affect how the tree is displayed +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          TreeStyle
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Namespace: Terminal.Gui.Trees
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                          public class TreeStyle
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Properties +

                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                          CollapseableSymbol

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +Symbol to use for branch nodes that can be collapsed (are currently expanded). +Defaults to '-'. Set to null to hide +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                          public Rune? CollapseableSymbol { get; set; }
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                          System.Nullable<System.Rune>
                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                          ColorExpandSymbol

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +Set to true to highlight expand/collapse symbols in hot key color +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                          public bool ColorExpandSymbol { get; set; }
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                          ExpandableSymbol

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +Symbol to use for branch nodes that can be expanded to indicate this to the user. +Defaults to '+'. Set to null to hide +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                          public Rune? ExpandableSymbol { get; set; }
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                          System.Nullable<System.Rune>
                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                          InvertExpandSymbolColors

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +Invert console colours used to render the expand symbol +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                          public bool InvertExpandSymbolColors { get; set; }
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                          LeaveLastRow

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +True to leave the last row of the control free for overwritting (e.g. by a scrollbar) +When True scrolling will be triggered on the second last row of the control rather than +the last. +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                          public bool LeaveLastRow { get; set; }
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                          ShowBranchLines

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +True to render vertical lines under expanded nodes to show which node belongs to which +parent. False to use only whitespace +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                          public bool ShowBranchLines { get; set; }
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Trees.html b/docs/api/Terminal.Gui/Terminal.Gui.Trees.html new file mode 100644 index 0000000000..809e2961fa --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Trees.html @@ -0,0 +1,169 @@ + + + + + + + + Namespace Terminal.Gui.Trees + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                            Namespace Terminal.Gui.Trees +

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Classes +

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            DelegateTreeBuilder<T>

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +Implementation of ITreeBuilder<T> that uses user defined functions +
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            ObjectActivatedEventArgs<T>

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +Event args for the ObjectActivated event +
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            SelectionChangedEventArgs<T>

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +Event arguments describing a change in selected object in a tree view +
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            TreeBuilder<T>

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +Abstract implementation of ITreeBuilder<T>. +
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            TreeNode

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +Simple class for representing nodes, use with regular (non generic) TreeView. +
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            TreeNodeBuilder

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +ITreeBuilder<T> implementation for ITreeNode objects +
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            TreeStyle

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +Defines rendering options that affect how the tree is displayed +
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Interfaces +

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            ITreeBuilder<T>

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +Interface for supplying data to a TreeView<T> on demand as root level nodes +are expanded by the user +
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            ITreeNode

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +Interface to implement when you want the regular (non generic) TreeView +to automatically determine children for your class (without having to specify +an ITreeBuilder<T>) +
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Delegates +

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            AspectGetterDelegate<T>

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +Delegates of this type are used to fetch string representations of user's model objects +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.VerticalTextAlignment.html b/docs/api/Terminal.Gui/Terminal.Gui.VerticalTextAlignment.html new file mode 100644 index 0000000000..151ace1353 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.VerticalTextAlignment.html @@ -0,0 +1,164 @@ + + + + + + + + Enum VerticalTextAlignment + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                                                              Enum VerticalTextAlignment +

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +Vertical text alignment enumeration, controls how text is displayed. +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                              public enum VerticalTextAlignment
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              Fields +

                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                              NameDescription
                                                                                                                                                                                                                                                                                                              Bottom +Aligns the text to the bottom of the frame. +
                                                                                                                                                                                                                                                                                                              Justified +Shows the text as justified text in the frame. +
                                                                                                                                                                                                                                                                                                              Middle +Centers the text verticaly in the frame. +
                                                                                                                                                                                                                                                                                                              Top +Aligns the text to the top of the frame. +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.View.FocusEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.View.FocusEventArgs.html new file mode 100644 index 0000000000..c1b2954ef1 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.View.FocusEventArgs.html @@ -0,0 +1,243 @@ + + + + + + + + Class View.FocusEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                Class View.FocusEventArgs +

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +Defines the event arguments for Terminal.Gui.View.SetFocus(Terminal.Gui.View) +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                System.EventArgs
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                View.FocusEventArgs
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + System.EventArgs.Empty +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                public class FocusEventArgs : EventArgs
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Constructors +

                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                FocusEventArgs(View)

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +Constructs. +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                public FocusEventArgs(View view)
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                ViewviewThe view that gets or loses focus.
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Properties +

                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                Handled

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +Indicates if the current focus event has already been processed and the driver should stop notifying any other event subscriber. +Its important to set this value to true specially when updating any View's layout from inside the subscriber method. +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                public bool Handled { get; set; }
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                View

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +Indicates the current view that gets or loses focus. +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                public View View { get; set; }
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                View
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.View.KeyEventEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.View.KeyEventEventArgs.html new file mode 100644 index 0000000000..6735d227ae --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.View.KeyEventEventArgs.html @@ -0,0 +1,243 @@ + + + + + + + + Class View.KeyEventEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                  Class View.KeyEventEventArgs +

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +Defines the event arguments for KeyEvent +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  System.EventArgs
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  View.KeyEventEventArgs
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + System.EventArgs.Empty +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                  public class KeyEventEventArgs : EventArgs
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                  Constructors +

                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                  KeyEventEventArgs(KeyEvent)

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +Constructs. +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                  public KeyEventEventArgs(KeyEvent ke)
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                                                                                                                                  KeyEventke
                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                  Properties +

                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                  Handled

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +Indicates if the current Key event has already been processed and the driver should stop notifying any other event subscriber. +Its important to set this value to true specially when updating any View's layout from inside the subscriber method. +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                  public bool Handled { get; set; }
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                                                  System.Boolean
                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                  KeyEvent

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +The KeyEvent for the event. +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                  public KeyEvent KeyEvent { get; set; }
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                                                  KeyEvent
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.View.LayoutEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.View.LayoutEventArgs.html new file mode 100644 index 0000000000..35403838ba --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.View.LayoutEventArgs.html @@ -0,0 +1,188 @@ + + + + + + + + Class View.LayoutEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                    Class View.LayoutEventArgs +

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +Event arguments for the LayoutComplete event. +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    System.EventArgs
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    View.LayoutEventArgs
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + System.EventArgs.Empty +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                    public class LayoutEventArgs : EventArgs
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    Properties +

                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                    OldBounds

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +The view-relative bounds of the View before it was laid out. +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                    public Rect OldBounds { get; set; }
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                    Rect
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.View.MouseEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.View.MouseEventArgs.html new file mode 100644 index 0000000000..c06c4d7514 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.View.MouseEventArgs.html @@ -0,0 +1,243 @@ + + + + + + + + Class View.MouseEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                                      Class View.MouseEventArgs +

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +Specifies the event arguments for MouseEvent +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      System.EventArgs
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      View.MouseEventArgs
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + System.EventArgs.Empty +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                      public class MouseEventArgs : EventArgs
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Constructors +

                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                      MouseEventArgs(MouseEvent)

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +Constructs. +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                      public MouseEventArgs(MouseEvent me)
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                                      MouseEventme
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Properties +

                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                      Handled

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +Indicates if the current mouse event has already been processed and the driver should stop notifying any other event subscriber. +Its important to set this value to true specially when updating any View's layout from inside the subscriber method. +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                      public bool Handled { get; set; }
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                      System.Boolean
                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                      MouseEvent

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +The MouseEvent for the event. +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                      public MouseEvent MouseEvent { get; set; }
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                      MouseEvent
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.View.html b/docs/api/Terminal.Gui/Terminal.Gui.View.html new file mode 100644 index 0000000000..8d6cf8749a --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.View.html @@ -0,0 +1,4303 @@ + + + + + + + + Class View + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        Class View +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Responder
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        View
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Button
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        CheckBox
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        ColorPicker
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        ComboBox
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        FrameView
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        GraphView
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        HexView
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Label
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        LineView
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        ListView
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        MenuBar
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        PanelView
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        ProgressBar
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        RadioGroup
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        ScrollBarView
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        ScrollView
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        StatusBar
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        TableView
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        TabView
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        TextField
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        TextValidateField
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        TextView
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Toplevel
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        TreeView<T>
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Implements
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        System.IDisposable
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public class View : Responder, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + The View defines the base functionality for user interface elements in Terminal.Gui. Views + can contain one or more subviews, can respond to user input and render themselves on the screen. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Views supports two layout styles: Absolute or Computed. The choice as to which layout style is used by the View + is determined when the View is initialized. To create a View using Absolute layout, call a constructor that takes a + Rect parameter to specify the absolute position and size (the View.Frame)/. To create a View + using Computed layout use a constructor that does not take a Rect parameter and set the X, Y, Width and Height + properties on the view. Both approaches use coordinates that are relative to the container they are being added to. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + To switch between Absolute and Computed layout, use the LayoutStyle property. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Computed layout is more flexible and supports dynamic console apps where controls adjust layout + as the terminal resizes or other Views change size or position. The X, Y, Width and Height + properties are Dim and Pos objects that dynamically update the position of a view. + The X and Y properties are of type Pos + and you can use either absolute positions, percentages or anchor + points. The Width and Height properties are of type +Dim and can use absolute position, +percentages and anchors. These are useful as they will take +care of repositioning views when view's frames are resized or +if the terminal size changes. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Absolute layout requires specifying coordinates and sizes of Views explicitly, and the + View will typically stay in a fixed position and size. To change the position and size use the +Frame property. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Subviews (child views) can be added to a View by calling the Add(View) method. + The container of a View can be accessed with the SuperView property. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + To flag a region of the View's Bounds to be redrawn call SetNeedsDisplay(Rect). To flag the entire view + for redraw call SetNeedsDisplay(). +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Views have a ColorScheme property that defines the default colors that subviews + should use for rendering. This ensures that the views fit in the context where + they are being used, and allows for themes to be plugged in. For example, the + default colors for windows and toplevels uses a blue background, while it uses + a white background for dialog boxes and a red background for errors. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Subclasses should not rely on ColorScheme being + set at construction time. If a ColorScheme is not set on a view, the view will inherit the + value from its SuperView and the value might only be valid once a view has been + added to a SuperView. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + By using ColorScheme applications will work both + in color as well as black and white displays. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Views that are focusable should implement the PositionCursor() to make sure that + the cursor is placed in a location that makes sense. Unix terminals do not have + a way of hiding the cursor, so it can be distracting to have the cursor left at + the last focused view. So views should make sure that they place the cursor + in a visually sensible place. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + The LayoutSubviews() method is invoked when the size or layout of a view has + changed. The default processing system will keep the size and dimensions + for views that use the Absolute, and will recompute the + frames for the vies that use Computed. +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Constructors +

                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        View()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Initializes a new instance of View using Computed layout. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public View()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Use X, Y, Width, and Height properties to dynamically control the size and location of the view. + The Label will be created using Computed + coordinates. The initial size (Frame will be + adjusted to fit the contents of Text, including newlines ('\n') for multiple lines. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + If Height is greater than one, word wrapping is provided. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + This constructor initialize a View with a LayoutStyle of Computed. + Use X, Y, Width, and Height properties to dynamically control the size and location of the view. +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        View(ustring, TextDirection, Border)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Initializes a new instance of View using Computed layout. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public View(ustring text, TextDirection direction = TextDirection.LeftRight_TopBottom, Border border = null)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        NStack.ustringtexttext to initialize the Text property with.
                                                                                                                                                                                                                                                                                                                        TextDirectiondirectionThe text direction.
                                                                                                                                                                                                                                                                                                                        BorderborderThe Border.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + The View will be created using Computed + coordinates with the given string. The initial size (Frame will be + adjusted to fit the contents of Text, including newlines ('\n') for multiple lines. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + If Height is greater than one, word wrapping is provided. +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        View(Int32, Int32, ustring)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Initializes a new instance of View using Absolute layout. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public View(int x, int y, ustring text)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        System.Int32xcolumn to locate the Label.
                                                                                                                                                                                                                                                                                                                        System.Int32yrow to locate the Label.
                                                                                                                                                                                                                                                                                                                        NStack.ustringtexttext to initialize the Text property with.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + The View will be created at the given + coordinates with the given string. The size (Frame will be + adjusted to fit the contents of Text, including newlines ('\n') for multiple lines. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + No line wrapping is provided. +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        View(Rect)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Initializes a new instance of a Absolute View class with the absolute +dimensions specified in the frame parameter. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public View(Rect frame)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        RectframeThe region covered by this view.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +This constructor initialize a View with a LayoutStyle of Absolute. Use View() to +initialize a View with LayoutStyle of Computed +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        View(Rect, ustring, Border)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Initializes a new instance of View using Absolute layout. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public View(Rect rect, ustring text, Border border = null)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        RectrectLocation.
                                                                                                                                                                                                                                                                                                                        NStack.ustringtexttext to initialize the Text property with.
                                                                                                                                                                                                                                                                                                                        BorderborderThe Border.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + The View will be created at the given + coordinates with the given string. The initial size (Frame will be + adjusted to fit the contents of Text, including newlines ('\n') for multiple lines. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + If rect.Height is greater than one, word wrapping is provided. +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Properties +

                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        AutoSize

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets a flag that determines whether the View will be automatically resized to fit the Text. +The default is `false`. Set to `true` to turn on AutoSize. If AutoSize is `true` the Width +and Height will always be used if the text size is lower. If the text size is higher the bounds will +be resized to fit it. +In addition, if ForceValidatePosDim is `true` the new values of Width and +Height must be of the same types of the existing one to avoid breaking the Dim settings. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual bool AutoSize { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Border

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual Border Border { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        Border
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Bounds

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +The bounds represent the View-relative rectangle used for this view; the area inside of the view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public Rect Bounds { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        RectThe bounds.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        +Updates to the Bounds update the Frame, +and has the same side effects as updating the Frame. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        +Because Bounds coordinates are relative to the upper-left corner of the View, +the coordinates of the upper-left corner of the rectangle returned by this property are (0,0). +Use this property to obtain the size and coordinates of the client area of the +control for tasks such as drawing on the surface of the control. +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        CanFocus

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override bool CanFocus { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        ColorScheme

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +The color scheme for this view, if it is not defined, it returns the SuperView's +color scheme. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual ColorScheme ColorScheme { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        ColorScheme
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Data

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets arbitrary data for the view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public object Data { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        This property is not used internally.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Driver

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Points to the current driver in use by the view, it is a convenience property +for simplifying the development of new views. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public static ConsoleDriver Driver { get; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        ConsoleDriver
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Enabled

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override bool Enabled { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        Focused

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Returns the currently focused view inside this view, or null if nothing is focused. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public View Focused { get; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        ViewThe focused.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        ForceValidatePosDim

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Forces validation with Computed layout +to avoid breaking the Pos and Dim settings. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public bool ForceValidatePosDim { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Frame

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets the frame for the view. The frame is relative to the view's container (SuperView). +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual Rect Frame { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        RectThe frame.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Change the Frame when using the Absolute layout style to move or resize views. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Altering the Frame of a view will trigger the redrawing of the + view as well as the redrawing of the affected regions of the SuperView. +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        HasFocus

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override bool HasFocus { get; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        Height

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets the height of the view. Only used the LayoutStyle is Computed. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public Dim Height { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        DimThe height.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        HotKey

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets the HotKey defined for this view. A user pressing HotKey on the keyboard while this view has focus will cause the Clicked event to fire. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual Key HotKey { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        Key
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        HotKeySpecifier

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets the specifier character for the hotkey (e.g. '_'). Set to '\xffff' to disable hotkey support for this View instance. The default is '\xffff'. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual Rune HotKeySpecifier { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Rune
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Id

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets an identifier for the view; +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public ustring Id { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        NStack.ustringThe identifier.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        The id should be unique across all Views that share a SuperView.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        IsAdded

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets information if the view was already added to the SuperView. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public bool IsAdded { get; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        IsCurrentTop

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Returns a value indicating if this View is currently on Top (Active) +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public bool IsCurrentTop { get; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        IsInitialized

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Get or sets if the View was already initialized. +This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are being initialized. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual bool IsInitialized { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        LayoutStyle

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Controls how the View's Frame is computed during the LayoutSubviews method, if the style is set to Absolute, +LayoutSubviews does not change the Frame. If the style is Computed the Frame is updated using +the X, Y, Width, and Height properties. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public LayoutStyle LayoutStyle { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        LayoutStyleThe layout style.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        MostFocused

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Returns the most focused view in the chain of subviews (the leaf view that has the focus). +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public View MostFocused { get; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        ViewThe most focused.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        PreserveTrailingSpaces

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets a flag that determines whether Text will have trailing spaces preserved +or not when WordWrap(ustring, Int32, Boolean, Int32, TextDirection) is enabled. If `true` any trailing spaces will be trimmed when +either the Text property is changed or when WordWrap(ustring, Int32, Boolean, Int32, TextDirection) is set to `true`. +The default is `false`. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual bool PreserveTrailingSpaces { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Shortcut

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +This is the global setting that can be used as a global shortcut to invoke an action if provided. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public Key Shortcut { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        Key
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        ShortcutAction

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +The action to run if the Shortcut is defined. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual Action ShortcutAction { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        ShortcutTag

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +The keystroke combination used in the Shortcut as string. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public ustring ShortcutTag { get; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        NStack.ustring
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Subviews

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +This returns a list of the subviews contained by this view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public IList<View> Subviews { get; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Collections.Generic.IList<View>The subviews.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        SuperView

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Returns the container for this view, or null if this view has not been added to a container. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public View SuperView { get; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        ViewThe super view.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        TabIndex

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Indicates the index of the current View from the TabIndexes list. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public int TabIndex { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Int32
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        TabIndexes

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +This returns a tab index list of the subviews contained by this view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public IList<View> TabIndexes { get; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Collections.Generic.IList<View>The tabIndexes.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        TabStop

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +This only be true if the CanFocus is also true and the focus can be avoided by setting this to false +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public bool TabStop { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Text

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +The text displayed by the View. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual ustring Text { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        NStack.ustring
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + If provided, the text will be drawn before any subviews are drawn. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + The text will be drawn starting at the view origin (0, 0) and will be formatted according + to the TextAlignment property. If the view's height is greater than 1, the + text will word-wrap to additional lines if it does not fit horizontally. If the view's height + is 1, the text will be clipped. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Set the HotKeySpecifier to enable hotkey support. To disable hotkey support set HotKeySpecifier to +(Rune)0xffff. +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        TextAlignment

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets how the View's Text is aligned horizontally when drawn. Changing this property will redisplay the View. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual TextAlignment TextAlignment { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        TextAlignmentThe text alignment.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        TextDirection

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets the direction of the View's Text. Changing this property will redisplay the View. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual TextDirection TextDirection { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        TextDirectionThe text alignment.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        TextFormatter

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets the TextFormatter which can be handled differently by any derived class. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public TextFormatter TextFormatter { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        TextFormatter
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        VerticalTextAlignment

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets how the View's Text is aligned verticaly when drawn. Changing this property will redisplay the View. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual VerticalTextAlignment VerticalTextAlignment { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        VerticalTextAlignmentThe text alignment.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Visible

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override bool Visible { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        WantContinuousButtonPressed

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets a value indicating whether this View want continuous button pressed event. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual bool WantContinuousButtonPressed { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        WantMousePositionReports

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets a value indicating whether this View wants mouse position reports. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual bool WantMousePositionReports { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Booleantrue if want mouse position reports; otherwise, false.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Width

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets the width of the view. Only used the LayoutStyle is Computed. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public Dim Width { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        DimThe width.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        X

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets the X position for the view (the column). Only used the LayoutStyle is Computed. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public Pos X { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        PosThe X Position.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Y

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets or sets the Y position for the view (the row). Only used the LayoutStyle is Computed. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public Pos Y { get; set; }
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        PosThe y position (line).
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Add(View)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Adds a subview (child) to this view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual void Add(View view)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        Viewview
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Add(View[])

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Adds the specified views (children) to the view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void Add(params View[] views)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        View[]viewsArray of one or more views (can be optional parameter).
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        AddCommand(Command, Func<Nullable<Boolean>>)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        States that the given View supports a given command +and what f to perform to make that command happen +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        If the command already has an implementation the f +will replace the old one

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        protected void AddCommand(Command command, Func<bool?> f)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        CommandcommandThe command.
                                                                                                                                                                                                                                                                                                                        System.Func<System.Nullable<System.Boolean>>fThe function.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        AddKeyBinding(Key, Command)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Adds a new key combination that will trigger the given command +(if supported by the View - see GetSupportedCommands()) +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        If the key is already bound to a different Command it will be +rebound to this one

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void AddKeyBinding(Key key, Command command)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        Keykey
                                                                                                                                                                                                                                                                                                                        Commandcommand
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        AddRune(Int32, Int32, Rune)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Displays the specified character in the specified column and row of the View. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void AddRune(int col, int row, Rune ch)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        System.Int32colColumn (view-relative).
                                                                                                                                                                                                                                                                                                                        System.Int32rowRow (view-relative).
                                                                                                                                                                                                                                                                                                                        System.RunechCh.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        BeginInit()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are beginning initialized. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void BeginInit()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        BringSubviewForward(View)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Moves the subview backwards in the hierarchy, only one step +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void BringSubviewForward(View subview)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        ViewsubviewThe subview to send backwards
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +If you want to send the view all the way to the back use SendSubviewToBack. +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        BringSubviewToFront(View)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Brings the specified subview to the front so it is drawn on top of any other views. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void BringSubviewToFront(View subview)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        ViewsubviewThe subview to send to the front
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +SendSubviewToBack(View). +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Clear()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Clears the view region with the current color. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void Clear()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + This clears the entire region used by this view. +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Clear(Rect)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Clears the specified region with the current color. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void Clear(Rect regionScreen)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        RectregionScreenThe screen-relative region to clear.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        ClearKeybinding(Command)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Removes all key bindings that trigger the given command. Views can have multiple different +keys bound to the same command and this method will clear all of them. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void ClearKeybinding(Command command)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        Commandcommand
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        ClearKeybinding(Key)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Clears the existing keybinding (if any) for the given key +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void ClearKeybinding(Key key)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        Keykey
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        ClearKeybindings()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Removes all bound keys from the View making including the default +key combinations such as cursor navigation, scrolling etc +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void ClearKeybindings()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        ClearLayoutNeeded()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Removes the Terminal.Gui.View.SetNeedsLayout setting on this view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        protected void ClearLayoutNeeded()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        ClearNeedsDisplay()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Removes the SetNeedsDisplay() and the Terminal.Gui.View.ChildNeedsDisplay setting on this view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        protected void ClearNeedsDisplay()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        ClipToBounds()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Sets the ConsoleDriver's clip region to the current View's Bounds. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public Rect ClipToBounds()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        RectThe existing driver's clip region, which can be then re-applied by setting Driver.Clip (Clip).
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Bounds is View-relative. +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        ContainsKeyBinding(Key)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Checks if key combination already exist. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public bool ContainsKeyBinding(Key key)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        KeykeyThe key to check.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Booleantrue If the key already exist, falseotherwise.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Dispose(Boolean)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        protected override void Dispose(bool disposing)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        System.Booleandisposing
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        DrawFrame(Rect, Int32, Boolean)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Draws a frame in the current view, clipped by the boundary of this view +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void DrawFrame(Rect region, int padding = 0, bool fill = false)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        RectregionView-relative region for the frame to be drawn.
                                                                                                                                                                                                                                                                                                                        System.Int32paddingThe padding to add around the outside of the drawn frame.
                                                                                                                                                                                                                                                                                                                        System.BooleanfillIf set to true it fill will the contents.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        DrawHotString(ustring, Boolean, ColorScheme)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Utility function to draw strings that contains a hotkey using a ColorScheme and the "focused" state. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void DrawHotString(ustring text, bool focused, ColorScheme scheme)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        NStack.ustringtextString to display, the underscore before a letter flags the next letter as the hotkey.
                                                                                                                                                                                                                                                                                                                        System.BooleanfocusedIf set to true this uses the focused colors from the color scheme, otherwise the regular ones.
                                                                                                                                                                                                                                                                                                                        ColorSchemeschemeThe color scheme to use.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        DrawHotString(ustring, Attribute, Attribute)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Utility function to draw strings that contain a hotkey. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void DrawHotString(ustring text, Attribute hotColor, Attribute normalColor)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        NStack.ustringtextString to display, the hotkey specifier before a letter flags the next letter as the hotkey.
                                                                                                                                                                                                                                                                                                                        AttributehotColorHot color.
                                                                                                                                                                                                                                                                                                                        AttributenormalColorNormal color.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        The hotkey is any character following the hotkey specifier, which is the underscore ('_') character by default.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        The hotkey specifier can be changed via HotKeySpecifier

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        EndInit()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are ending initialized. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void EndInit()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        EnsureFocus()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void EnsureFocus()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        FocusFirst()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Focuses the first focusable subview if one exists. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void FocusFirst()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        FocusLast()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Focuses the last focusable subview if one exists. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void FocusLast()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        FocusNext()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Focuses the next view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public bool FocusNext()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Booleantrue, if next was focused, false otherwise.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        FocusPrev()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Focuses the previous view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public bool FocusPrev()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Booleantrue, if previous was focused, false otherwise.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        GetAutoSize()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets the size to fit all text if AutoSize is true. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public Size GetAutoSize()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        SizeThe Size
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        GetBoundsTextFormatterSize()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets the text formatter size from a Bounds size. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public Size GetBoundsTextFormatterSize()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        SizeThe text formatter size more the HotKeySpecifier length.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        GetCurrentHeight(out Int32)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Calculate the height based on the Height settings. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public bool GetCurrentHeight(out int currentHeight)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        System.Int32currentHeightThe real current height.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Booleantrue if the height can be directly assigned, false otherwise.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        GetCurrentWidth(out Int32)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets the current width based on the Width settings. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public bool GetCurrentWidth(out int currentWidth)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        System.Int32currentWidthThe real current width.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Booleantrue if the width can be directly assigned, false otherwise.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        GetHotKeySpecifierLength(Boolean)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Get the width or height of the HotKeySpecifier length. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public int GetHotKeySpecifierLength(bool isWidth = true)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        System.BooleanisWidthtrueif is the width (default)falseif is the height.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Int32The length of the HotKeySpecifier.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        GetKeyFromCommand(Command)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets the key used by a command. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public Key GetKeyFromCommand(Command command)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        CommandcommandThe command to search.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        KeyThe Key used by a Command
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        GetMinWidthHeight(out Size)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Verifies if the minimum width or height can be sets in the view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public bool GetMinWidthHeight(out Size size)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        SizesizeThe size.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Booleantrue if the size can be set, falseotherwise.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        GetNormalColor()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Determines the current ColorScheme based on the Enabled value. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public Attribute GetNormalColor()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        AttributeNormal if Enabled is true + or Disabled if Enabled is false
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        GetSupportedCommands()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Returns all commands that are supported by this View +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public IEnumerable<Command> GetSupportedCommands()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Collections.Generic.IEnumerable<Command>
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        GetTextFormatterBoundsSize()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Gets the bounds size from a Size. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public Size GetTextFormatterBoundsSize()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        SizeThe bounds size minus the HotKeySpecifier length.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        GetTopSuperView()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Get the top superview of a given View. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public View GetTopSuperView()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        ViewThe superview view.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        InvokeKeybindings(KeyEvent)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Invokes any binding that is registered on this View +and matches the keyEvent +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        protected bool? InvokeKeybindings(KeyEvent keyEvent)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        KeyEventkeyEventThe key event passed.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Nullable<System.Boolean>
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        LayoutSubviews()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Invoked when a view starts executing or when the dimensions of the view have changed, for example in +response to the container view or terminal resizing. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual void LayoutSubviews()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Calls Terminal.Gui.View.OnLayoutComplete(Terminal.Gui.View.LayoutEventArgs) (which raises the LayoutComplete event) before it returns. +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Move(Int32, Int32, Boolean)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +This moves the cursor to the specified column and row in the view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void Move(int col, int row, bool clipped = true)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        System.Int32colCol.
                                                                                                                                                                                                                                                                                                                        System.Int32rowRow.
                                                                                                                                                                                                                                                                                                                        System.BooleanclippedWhether to clip the result of the ViewToScreen method, + if set to true, the col, row values are clamped to the screen (terminal) dimensions (0..TerminalDim-1).
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        OnAdded(View)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Method invoked when a subview is being added to this view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual void OnAdded(View view)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        ViewviewThe subview being added.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        OnCanFocusChanged()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override void OnCanFocusChanged()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        OnDrawContent(Rect)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Enables overrides to draw infinitely scrolled content and/or a background behind added controls. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual void OnDrawContent(Rect viewport)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        RectviewportThe view-relative rectangle describing the currently visible viewport into the View
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +This method will be called before any subviews added with Add(View) have been drawn. +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        OnDrawContentComplete(Rect)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Enables overrides after completed drawing infinitely scrolled content and/or a background behind removed controls. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual void OnDrawContentComplete(Rect viewport)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        RectviewportThe view-relative rectangle describing the currently visible viewport into the View
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +This method will be called after any subviews removed with Remove(View) have been completed drawing. +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        OnEnabledChanged()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override void OnEnabledChanged()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        OnEnter(View)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override bool OnEnter(View view)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        Viewview
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        OnKeyDown(KeyEvent)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override bool OnKeyDown(KeyEvent keyEvent)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        KeyEventkeyEvent
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        OnKeyUp(KeyEvent)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override bool OnKeyUp(KeyEvent keyEvent)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        KeyEventkeyEvent
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        OnLeave(View)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override bool OnLeave(View view)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        Viewview
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        OnMouseClick(View.MouseEventArgs)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Invokes the MouseClick event. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        protected bool OnMouseClick(View.MouseEventArgs args)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        View.MouseEventArgsargs
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        OnMouseEnter(MouseEvent)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override bool OnMouseEnter(MouseEvent mouseEvent)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        MouseEventmouseEvent
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        OnMouseEvent(MouseEvent)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Method invoked when a mouse event is generated +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual bool OnMouseEvent(MouseEvent mouseEvent)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        MouseEventmouseEvent
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Booleantrue, if the event was handled, false otherwise.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        OnMouseLeave(MouseEvent)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override bool OnMouseLeave(MouseEvent mouseEvent)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        MouseEventmouseEvent
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        OnRemoved(View)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Method invoked when a subview is being removed from this view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual void OnRemoved(View view)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        ViewviewThe subview being removed.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        OnVisibleChanged()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override void OnVisibleChanged()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        PositionCursor()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Positions the cursor in the right position based on the currently focused view in the chain. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual void PositionCursor()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        ProcessColdKey(KeyEvent)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override bool ProcessColdKey(KeyEvent keyEvent)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        KeyEventkeyEvent
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        ProcessHotKey(KeyEvent)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override bool ProcessHotKey(KeyEvent keyEvent)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        KeyEventkeyEvent
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        ProcessKey(KeyEvent)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override bool ProcessKey(KeyEvent keyEvent)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        KeyEventkeyEvent
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        ProcessResizeView()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Can be overridden if the view resize behavior is +different than the default. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        protected virtual void ProcessResizeView()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Redraw(Rect)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual void Redraw(Rect bounds)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        RectboundsThe bounds (view-relative region) to redraw.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region + larger than the region parameter. +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Remove(View)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Removes a subview added via Add(View) or Add(View[]) from this View. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual void Remove(View view)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        Viewview
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        RemoveAll()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Removes all subviews (children) added via Add(View) or Add(View[]) from this View. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public virtual void RemoveAll()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        ReplaceKeyBinding(Key, Key)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Replaces a key combination already bound to Command. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        protected void ReplaceKeyBinding(Key fromKey, Key toKey)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        KeyfromKeyThe key to be replaced.
                                                                                                                                                                                                                                                                                                                        KeytoKeyThe new key to be used.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        ScreenToView(Int32, Int32)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Converts a point from screen-relative coordinates to view-relative coordinates. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public Point ScreenToView(int x, int y)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        System.Int32xX screen-coordinate point.
                                                                                                                                                                                                                                                                                                                        System.Int32yY screen-coordinate point.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        PointThe mapped point.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        SendSubviewBackwards(View)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Moves the subview backwards in the hierarchy, only one step +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void SendSubviewBackwards(View subview)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        ViewsubviewThe subview to send backwards
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +If you want to send the view all the way to the back use SendSubviewToBack. +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        SendSubviewToBack(View)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Sends the specified subview to the front so it is the first view drawn +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void SendSubviewToBack(View subview)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        ViewsubviewThe subview to send to the front
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +BringSubviewToFront(View). +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        SetChildNeedsDisplay()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Indicates that any child views (in the Subviews list) need to be repainted. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void SetChildNeedsDisplay()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        SetClip(Rect)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Sets the clip region to the specified view-relative region. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public Rect SetClip(Rect region)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        RectregionView-relative clip region.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        RectThe previous screen-relative clip region.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        SetFocus()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Causes the specified view and the entire parent hierarchy to have the focused order updated. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void SetFocus()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        SetHeight(Int32, out Int32)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Calculate the height based on the Height settings. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public bool SetHeight(int desiredHeight, out int resultHeight)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        System.Int32desiredHeightThe desired height.
                                                                                                                                                                                                                                                                                                                        System.Int32resultHeightThe real result height.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Booleantrue if the height can be directly assigned, false otherwise.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        SetMinWidthHeight()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Sets the minimum width or height if the view can be resized. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public bool SetMinWidthHeight()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Booleantrue if the size can be set, falseotherwise.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        SetNeedsDisplay()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Sets a flag indicating this view needs to be redisplayed because its state has changed. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void SetNeedsDisplay()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        SetNeedsDisplay(Rect)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Flags the view-relative region on this View as needing to be repainted. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public void SetNeedsDisplay(Rect region)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        RectregionThe view-relative region that must be flagged for repaint.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        SetWidth(Int32, out Int32)

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Calculate the width based on the Width settings. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public bool SetWidth(int desiredWidth, out int resultWidth)
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                        System.Int32desiredWidthThe desired width.
                                                                                                                                                                                                                                                                                                                        System.Int32resultWidthThe real result width.
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Booleantrue if the width can be directly assigned, false otherwise.
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        ToString()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Pretty prints the View +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public override string ToString()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.String
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        System.Object.ToString()
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        UpdateTextFormatterText()

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Can be overridden if the Text has +different format than the default. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        protected virtual void UpdateTextFormatterText()
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Events +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Added

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Event fired when a subview is being added to this view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<View> Added
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<View>
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        CanFocusChanged

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Event fired when the CanFocus value is being changed. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action CanFocusChanged
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        DrawContent

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Event invoked when the content area of the View is to be drawn. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<Rect> DrawContent
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<Rect>
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        +Will be invoked before any subviews added with Add(View) have been drawn. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        +Rect provides the view-relative rectangle describing the currently visible viewport into the View. +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        DrawContentComplete

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Event invoked when the content area of the View is completed drawing. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<Rect> DrawContentComplete
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<Rect>
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        +Will be invoked after any subviews removed with Remove(View) have been completed drawing. +

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        +Rect provides the view-relative rectangle describing the currently visible viewport into the View. +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        EnabledChanged

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Event fired when the Enabled value is being changed. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action EnabledChanged
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Enter

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Event fired when the view gets focus. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<View.FocusEventArgs> Enter
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<View.FocusEventArgs>
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        HotKeyChanged

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Event invoked when the HotKey is changed. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<Key> HotKeyChanged
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<Key>
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Initialized

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Event called only once when the View is being initialized for the first time. +Allows configurations and assignments to be performed before the View being shown. +This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are being initialized. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event EventHandler Initialized
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.EventHandler
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        KeyDown

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Invoked when a key is pressed +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<View.KeyEventEventArgs> KeyDown
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<View.KeyEventEventArgs>
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        KeyPress

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Invoked when a character key is pressed and occurs after the key up event. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<View.KeyEventEventArgs> KeyPress
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<View.KeyEventEventArgs>
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        KeyUp

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Invoked when a key is released +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<View.KeyEventEventArgs> KeyUp
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<View.KeyEventEventArgs>
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        LayoutComplete

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Fired after the Views's LayoutSubviews() method has completed. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<View.LayoutEventArgs> LayoutComplete
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<View.LayoutEventArgs>
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        LayoutStarted

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Fired after the Views's LayoutSubviews() method has completed. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<View.LayoutEventArgs> LayoutStarted
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<View.LayoutEventArgs>
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Remarks
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Leave

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Event fired when the view looses focus. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<View.FocusEventArgs> Leave
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<View.FocusEventArgs>
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        MouseClick

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Event fired when a mouse event is generated. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<View.MouseEventArgs> MouseClick
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<View.MouseEventArgs>
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        MouseEnter

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Event fired when the view receives the mouse event for the first time. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<View.MouseEventArgs> MouseEnter
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<View.MouseEventArgs>
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        MouseLeave

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Event fired when the view receives a mouse event for the last time. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<View.MouseEventArgs> MouseLeave
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<View.MouseEventArgs>
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Removed

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Event fired when a subview is being removed from this view. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action<View> Removed
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action<View>
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        VisibleChanged

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +Event fired when the Visible value is being changed. +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                        public event Action VisibleChanged
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Event Type
                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                        System.Action
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + System.IDisposable +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Window.TitleEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.Window.TitleEventArgs.html new file mode 100644 index 0000000000..c15e942b49 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Window.TitleEventArgs.html @@ -0,0 +1,272 @@ + + + + + + + + Class Window.TitleEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                          Class Window.TitleEventArgs +

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +An System.EventArgs which allows passing a cancelable new Title value event. +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          System.EventArgs
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Window.TitleEventArgs
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + System.EventArgs.Empty +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                          public class TitleEventArgs : EventArgs
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Constructors +

                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                          TitleEventArgs(ustring, ustring)

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +Initializes a new instance of Window.TitleEventArgs +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                          public TitleEventArgs(ustring oldTitle, ustring newTitle)
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                                                                          NStack.ustringoldTitleThe Title that is/has been replaced.
                                                                                                                                                                                                                                                                                                                          NStack.ustringnewTitleThe new Title to be replaced.
                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Properties +

                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                          Cancel

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +Flag which allows cancelling the Title change. +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                          public bool Cancel { get; set; }
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                          System.Boolean
                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                          NewTitle

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +The new Window Title. +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                          public ustring NewTitle { get; set; }
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                          NStack.ustring
                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                          OldTitle

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +The old Window Title. +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                          public ustring OldTitle { get; set; }
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                          NStack.ustring
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Window.html b/docs/api/Terminal.Gui/Terminal.Gui.Window.html new file mode 100644 index 0000000000..a61b992351 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Window.html @@ -0,0 +1,1188 @@ + + + + + + + + Class Window + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                            Class Window +

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +A Toplevel View that draws a border around its Frame with a Title at the top. +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Responder
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            View
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Toplevel
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Window
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Dialog
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Implements
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            System.IDisposable
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            + View.Data +
                                                                                                                                                                                                                                                                                                                            + + + + + +
                                                                                                                                                                                                                                                                                                                            + View.Id +
                                                                                                                                                                                                                                                                                                                            + + + + + + +
                                                                                                                                                                                                                                                                                                                            + View.X +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + View.Y +
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public class Window : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Remarks
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +The 'client area' of a Window is a rectangle deflated by one or more rows/columns from Bounds. A this time there is no +API to determine this rectangle. +
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Constructors +

                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                            Window()

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +Initializes a new instance of the Window class using Computed positioning. +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public Window()
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                            Window(ustring)

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +Initializes a new instance of the Window class with an optional title using Computed positioning. +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public Window(ustring title = null)
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                            NStack.ustringtitleTitle.
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Remarks
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +This constructor initializes a View with a LayoutStyle of Computed. +Use X, Y, Width, and Height properties to dynamically control the size and location of the view. +
                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                            Window(ustring, Int32, Border)

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +Initializes a new instance of the Window using Computed positioning, +and an optional title. +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public Window(ustring title = null, int padding = 0, Border border = null)
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                            NStack.ustringtitleTitle.
                                                                                                                                                                                                                                                                                                                            System.Int32paddingNumber of characters to use for padding of the drawn frame.
                                                                                                                                                                                                                                                                                                                            BorderborderThe Border.
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Remarks
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +This constructor initializes a View with a LayoutStyle of Computed. +Use X, Y, Width, and Height properties to dynamically control the size and location of the view. +
                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                            Window(Rect, ustring)

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +Initializes a new instance of the Window class with an optional title using Absolute positioning. +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public Window(Rect frame, ustring title = null)
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                            RectframeSuperview-relative rectangle specifying the location and size
                                                                                                                                                                                                                                                                                                                            NStack.ustringtitleTitle
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Remarks
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +This constructor initializes a Window with a LayoutStyle of Absolute. Use constructors +that do not take Rect parameters to initialize a Window with Computed. +
                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                            Window(Rect, ustring, Int32, Border)

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +Initializes a new instance of the Window using Absolute positioning with the specified frame for its location, with the specified frame padding, +and an optional title. +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public Window(Rect frame, ustring title = null, int padding = 0, Border border = null)
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                            RectframeSuperview-relative rectangle specifying the location and size
                                                                                                                                                                                                                                                                                                                            NStack.ustringtitleTitle
                                                                                                                                                                                                                                                                                                                            System.Int32paddingNumber of characters to use for padding of the drawn frame.
                                                                                                                                                                                                                                                                                                                            BorderborderThe Border.
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Remarks
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +This constructor initializes a Window with a LayoutStyle of Absolute. Use constructors +that do not take Rect parameters to initialize a Window with LayoutStyle of Computed +
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Properties +

                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                            Border

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public override Border Border { get; set; }
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                            Border
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                            Text

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +The text displayed by the Label. +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public override ustring Text { get; set; }
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                            NStack.ustring
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                            TextAlignment

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +Controls the text-alignment property of the label, changing it will redisplay the Label. +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public override TextAlignment TextAlignment { get; set; }
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                            TextAlignmentThe text alignment.
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                            Title

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +The title to be displayed for this window. +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public ustring Title { get; set; }
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                            NStack.ustringThe title
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                            Add(View)

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public override void Add(View view)
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                            Viewview
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                            OnCanFocusChanged()

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public override void OnCanFocusChanged()
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                            OnTitleChanged(ustring, ustring)

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +Called when the Title has been changed. Invokes the TitleChanged event. +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public virtual void OnTitleChanged(ustring oldTitle, ustring newTitle)
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                            NStack.ustringoldTitleThe Title that is/has been replaced.
                                                                                                                                                                                                                                                                                                                            NStack.ustringnewTitleThe new Title to be replaced.
                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                            OnTitleChanging(ustring, ustring)

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +Called before the Title changes. Invokes the TitleChanging event, which can be cancelled. +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public virtual bool OnTitleChanging(ustring oldTitle, ustring newTitle)
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                            NStack.ustringoldTitleThe Title that is/has been replaced.
                                                                                                                                                                                                                                                                                                                            NStack.ustringnewTitleThe new Title to be replaced.
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                            System.Boolean`true` if an event handler cancelled the Title change.
                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                            Redraw(Rect)

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public override void Redraw(Rect bounds)
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                            Rectbounds
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                            Remove(View)

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public override void Remove(View view)
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                            Viewview
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                            RemoveAll()

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public override void RemoveAll()
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                            Events +

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            TitleChanged

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +Event fired after the Title has been changed. +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public event Action<Window.TitleEventArgs> TitleChanged
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                            System.Action<Window.TitleEventArgs>
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            TitleChanging

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +Event fired when the Title is changing. Set Cancel to +`true` to cancel the Title change. +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                            public event Action<Window.TitleEventArgs> TitleChanging
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                            System.Action<Window.TitleEventArgs>
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + System.IDisposable +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Wizard.StepChangeEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.Wizard.StepChangeEventArgs.html new file mode 100644 index 0000000000..3a0058f953 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Wizard.StepChangeEventArgs.html @@ -0,0 +1,272 @@ + + + + + + + + Class Wizard.StepChangeEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                                                                              Class Wizard.StepChangeEventArgs +

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +System.EventArgs for Wizard.WizardStep events. +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Inheritance
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              System.EventArgs
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Wizard.StepChangeEventArgs
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + System.EventArgs.Empty +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                              public class StepChangeEventArgs : EventArgs
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Constructors +

                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                              StepChangeEventArgs(Wizard.WizardStep, Wizard.WizardStep)

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +Initializes a new instance of Wizard.StepChangeEventArgs +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                              public StepChangeEventArgs(Wizard.WizardStep oldStep, Wizard.WizardStep newStep)
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                              Wizard.WizardStepoldStepThe current Wizard.WizardStep.
                                                                                                                                                                                                                                                                                                                              Wizard.WizardStepnewStepThe new Wizard.WizardStep.
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Properties +

                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                              Cancel

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +Event handlers can set to true before returning to cancel the step transition. +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                              public bool Cancel { get; set; }
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                              System.Boolean
                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                              NewStep

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +The Wizard.WizardStep the Wizard is changing to or has changed to. +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                              public Wizard.WizardStep NewStep { get; }
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                              Wizard.WizardStep
                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                              OldStep

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +The current (or previous) Wizard.WizardStep. +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                              public Wizard.WizardStep OldStep { get; }
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                              Wizard.WizardStep
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Wizard.WizardButtonEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.Wizard.WizardButtonEventArgs.html new file mode 100644 index 0000000000..896873fa89 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Wizard.WizardButtonEventArgs.html @@ -0,0 +1,200 @@ + + + + + + + + Class Wizard.WizardButtonEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                Class Wizard.WizardButtonEventArgs +

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +System.EventArgs for Wizard.WizardStep transition events. +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                System.EventArgs
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                Wizard.WizardButtonEventArgs
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + System.EventArgs.Empty +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                public class WizardButtonEventArgs : EventArgs
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Constructors +

                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                WizardButtonEventArgs()

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +Initializes a new instance of Wizard.WizardButtonEventArgs +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                public WizardButtonEventArgs()
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Properties +

                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                Cancel

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +Set to true to cancel the transition to the next step. +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                public bool Cancel { get; set; }
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Wizard.WizardStep.TitleEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.Wizard.WizardStep.TitleEventArgs.html new file mode 100644 index 0000000000..52dedcd644 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Wizard.WizardStep.TitleEventArgs.html @@ -0,0 +1,272 @@ + + + + + + + + Class Wizard.WizardStep.TitleEventArgs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                                  Class Wizard.WizardStep.TitleEventArgs +

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +An System.EventArgs which allows passing a cancelable new Title value event. +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  System.EventArgs
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Wizard.WizardStep.TitleEventArgs
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + System.EventArgs.Empty +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                  public class TitleEventArgs : EventArgs
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  Constructors +

                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                  TitleEventArgs(ustring, ustring)

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +Initializes a new instance of Wizard.WizardStep.TitleEventArgs +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                  public TitleEventArgs(ustring oldTitle, ustring newTitle)
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                                                                                                                                                  NStack.ustringoldTitleThe Title that is/has been replaced.
                                                                                                                                                                                                                                                                                                                                  NStack.ustringnewTitleThe new Title to be replaced.
                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  Properties +

                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                  Cancel

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +Flag which allows cancelling the Title change. +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                  public bool Cancel { get; set; }
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                                                                  System.Boolean
                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                  NewTitle

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +The new Window Title. +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                  public ustring NewTitle { get; set; }
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                                                                  NStack.ustring
                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                  OldTitle

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +The old Window Title. +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                  public ustring OldTitle { get; set; }
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                                                                  NStack.ustring
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Wizard.WizardStep.html b/docs/api/Terminal.Gui/Terminal.Gui.Wizard.WizardStep.html new file mode 100644 index 0000000000..9d66ce35a8 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Wizard.WizardStep.html @@ -0,0 +1,952 @@ + + + + + + + + Class Wizard.WizardStep + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                    Class Wizard.WizardStep +

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +Represents a basic step that is displayed in a Wizard. The Wizard.WizardStep view is divided horizontally in two. On the left is the +content view where Views can be added, On the right is the help for the step. +Set HelpText to set the help text. If the help text is empty the help pane will not +be shown. + +If there are no Views added to the WizardStep the HelpText (if not empty) will fill the wizard step. +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Responder
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    View
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    FrameView
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Wizard.WizardStep
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    System.IDisposable
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    + View.Data +
                                                                                                                                                                                                                                                                                                                                    + + + + + + +
                                                                                                                                                                                                                                                                                                                                    + View.Id +
                                                                                                                                                                                                                                                                                                                                    + + + + + + +
                                                                                                                                                                                                                                                                                                                                    + View.X +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + View.Y +
                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                    public class WizardStep : FrameView, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +If Buttons are added, do not set IsDefault to true as this will conflict +with the Next button of the Wizard. + +Subscribe to the VisibleChanged event to be notified when the step is active; see also: StepChanged. + +To enable or disable a step from being shown to the user, set Enabled. + +
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Constructors +

                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                    WizardStep(ustring)

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +Initializes a new instance of the Wizard class using Computed positioning. +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                    public WizardStep(ustring title)
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                    NStack.ustringtitleTitle for the Step. Will be appended to the containing Wizard's title as +"Wizard Title - Wizard Step Title" when this step is active.
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Properties +

                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                    BackButtonText

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +Sets or gets the text for the back button. The back button will only be visible on +steps after the first step. +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                    public ustring BackButtonText { get; set; }
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                    NStack.ustring
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    The default text is "Back"
                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                    HelpText

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +Sets or gets help text for the Wizard.WizardStep.If HelpText is empty +the help pane will not be visible and the content will fill the entire WizardStep. +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                    public ustring HelpText { get; set; }
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                    NStack.ustring
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    The help text is displayed using a read-only TextView.
                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                    NextButtonText

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +Sets or gets the text for the next/finish button. +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                    public ustring NextButtonText { get; set; }
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                    NStack.ustring
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    The default text is "Next..." if the Pane is not the last pane. Otherwise it is "Finish"
                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                    Title

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +The title of the Wizard.WizardStep. +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                    public ustring Title { get; set; }
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Property Value
                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                    NStack.ustring
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    The Title is only displayed when the Wizard is used as a modal pop-up.
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                    Add(View)

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +Add the specified View to the Wizard.WizardStep. +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                    public override void Add(View view)
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                    ViewviewView to add to this container
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                    OnTitleChanged(ustring, ustring)

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +Called when the Title has been changed. Invokes the TitleChanged event. +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                    public virtual void OnTitleChanged(ustring oldTitle, ustring newTitle)
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                    NStack.ustringoldTitleThe Title that is/has been replaced.
                                                                                                                                                                                                                                                                                                                                    NStack.ustringnewTitleThe new Title to be replaced.
                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                    OnTitleChanging(ustring, ustring)

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +Called before the Title changes. Invokes the TitleChanging event, which can be cancelled. +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                    public virtual bool OnTitleChanging(ustring oldTitle, ustring newTitle)
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                    NStack.ustringoldTitleThe Title that is/has been replaced.
                                                                                                                                                                                                                                                                                                                                    NStack.ustringnewTitleThe new Title to be replaced.
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                    System.Boolean`true` if an event handler cancelled the Title change.
                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                    Remove(View)

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +Removes a View from Wizard.WizardStep. +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                    public override void Remove(View view)
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                    Viewview
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                    RemoveAll()

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +Removes all Views from the Wizard.WizardStep. +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                    public override void RemoveAll()
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    Remarks
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Events +

                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    TitleChanged

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +Event fired after the Title has been changed. +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                    public event Action<Wizard.WizardStep.TitleEventArgs> TitleChanged
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Event Type
                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                    System.Action<Wizard.WizardStep.TitleEventArgs>
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    TitleChanging

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +Event fired when the Title is changing. Set Cancel to +`true` to cancel the Title change. +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                    public event Action<Wizard.WizardStep.TitleEventArgs> TitleChanging
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Event Type
                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                    System.Action<Wizard.WizardStep.TitleEventArgs>
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Wizard.html b/docs/api/Terminal.Gui/Terminal.Gui.Wizard.html new file mode 100644 index 0000000000..29b8945853 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Wizard.html @@ -0,0 +1,1414 @@ + + + + + + + + Class Wizard + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                                                      Class Wizard +

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step (Wizard.WizardStep) can host +arbitrary Views, much like a Dialog. Each step also has a pane for help text. Along the +bottom of the Wizard view are customizable buttons enabling the user to navigate forward and backward through the Wizard. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Responder
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      View
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Toplevel
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Window
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Dialog
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Wizard
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Implements
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      System.IDisposable
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      + View.Data +
                                                                                                                                                                                                                                                                                                                                      + + + + + +
                                                                                                                                                                                                                                                                                                                                      + View.Id +
                                                                                                                                                                                                                                                                                                                                      + + + + + + +
                                                                                                                                                                                                                                                                                                                                      + View.X +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + View.Y +
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Namespace: Terminal.Gui
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public class Wizard : Dialog, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Remarks
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +The Wizard can be displayed either as a modal (pop-up) Window (like Dialog) or as an embedded View. + +By default, Modal is true; launch the Wizard using `Application.Run(wizard)`. + +Set Modal to `false` to use Wizard as an embedded View, and add the Wizard to a containing view with Add(View). + +When used as a modal pop-up window, the Esc key will cause the Cancelled event to fire and (if the event is not cancelled), +will cause RequestStop(Toplevel) to be called, closing the Wizard. + +When used as an embedded View, no frame is drawn around the Wizard. To detect if the user wants to cancel +the Wizard, subscrie to the Cancelled event. + +
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Constructors +

                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      Wizard()

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Initializes a new instance of the Wizard class using Computed positioning. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public Wizard()
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Remarks
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +The Wizard will be vertically and horizontally centered in the container. +After initialization use X, Y, Width, and Height change size and position. +
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      Wizard(ustring)

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Initializes a new instance of the Wizard class using Computed positioning. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public Wizard(ustring title)
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                                                      NStack.ustringtitleSets the Title for the Wizard.
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Remarks
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +The Wizard will be vertically and horizontally centered in the container. +After initialization use X, Y, Width, and Height change size and position. +
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Properties +

                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      BackButton

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +If the CurrentStep is not the first step in the wizard, this button causes +the MovingBack event to be fired and the wizard moves to the previous step. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public Button BackButton { get; }
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      Button
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Remarks
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Use the MovingBack event to be notified when the user attempts to go back. +
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      CurrentStep

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Gets or sets the currently active Wizard.WizardStep. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public Wizard.WizardStep CurrentStep { get; set; }
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      Wizard.WizardStep
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      Modal

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Determines whether the Wizard is displayed as modal pop-up or not. + +The default is `true`. The Wizard will be shown with a frame with Title and will behave like +any Toplevel window. + +If set to `false` the Wizard will have no frame and will behave like any embedded View. + +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public bool Modal { get; set; }
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      System.Boolean
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      NextFinishButton

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +If the CurrentStep is the last step in the wizard, this button causes +the Finished event to be fired and the wizard to close. If the step is not the last step, +the MovingNext event will be fired and the wizard will move next step. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public Button NextFinishButton { get; }
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      Button
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Remarks
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Use the MovingNext and Finished events to be notified +when the user attempts go to the next step or finish the wizard. +
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      Title

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +The title of the Wizard, shown at the top of the Wizard with " - currentStep.Title" appended. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public ustring Title { get; set; }
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      NStack.ustring
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Remarks
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      The Title is only displayed when the Wizard is used as a modal pop-up.
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Methods +

                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      AddStep(Wizard.WizardStep)

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Adds a step to the wizard. The Next and Back buttons navigate through the added steps in the +order they were added. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public void AddStep(Wizard.WizardStep newStep)
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                                                      Wizard.WizardStepnewStep
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Remarks
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      The "Next..." button of the last step added will read "Finish" (unless changed from default).
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      GetFirstStep()

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Returns the first enabled step in the Wizard +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public Wizard.WizardStep GetFirstStep()
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      Wizard.WizardStepThe last enabled step
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      GetLastStep()

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Returns the last enabled step in the Wizard +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public Wizard.WizardStep GetLastStep()
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      Wizard.WizardStepThe last enabled step
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      GetNextStep()

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Returns the next enabled Wizard.WizardStep after the current step. Takes into account steps which +are disabled. If CurrentStep is `null` returns the first enabled step. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public Wizard.WizardStep GetNextStep()
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      Wizard.WizardStepThe next step after the current step, if there is one; otherwise returns `null`, which +indicates either there are no enabled steps or the current step is the last enabled step.
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      GetPreviousStep()

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Returns the first enabled Wizard.WizardStep before the current step. Takes into account steps which +are disabled. If CurrentStep is `null` returns the last enabled step. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public Wizard.WizardStep GetPreviousStep()
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      Wizard.WizardStepThe first step ahead of the current step, if there is one; otherwise returns `null`, which +indicates either there are no enabled steps or the current step is the first enabled step.
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      GoBack()

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Causes the wizad to move to the previous enabled step (or first step if CurrentStep is not set). +If there is no previous step, does nothing. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public void GoBack()
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      GoNext()

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Causes the wizad to move to the next enabled step (or last step if CurrentStep is not set). +If there is no previous step, does nothing. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public void GoNext()
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      GoToStep(Wizard.WizardStep)

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Changes to the specified Wizard.WizardStep. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public bool GoToStep(Wizard.WizardStep newStep)
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                                                      Wizard.WizardStepnewStepThe step to go to.
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      System.BooleanTrue if the transition to the step succeeded. False if the step was not found or the operation was cancelled.
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      OnStepChanged(Wizard.WizardStep, Wizard.WizardStep)

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Called when the Wizard has completed transition to a new Wizard.WizardStep. Fires the StepChanged event. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public virtual bool OnStepChanged(Wizard.WizardStep oldStep, Wizard.WizardStep newStep)
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                                                      Wizard.WizardStepoldStepThe step the Wizard changed from
                                                                                                                                                                                                                                                                                                                                      Wizard.WizardStepnewStepThe step the Wizard has changed to
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      System.BooleanTrue if the change is to be cancelled.
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      OnStepChanging(Wizard.WizardStep, Wizard.WizardStep)

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +Called when the Wizard is about to transition to another Wizard.WizardStep. Fires the StepChanging event. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public virtual bool OnStepChanging(Wizard.WizardStep oldStep, Wizard.WizardStep newStep)
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                                                      Wizard.WizardStepoldStepThe step the Wizard is about to change from
                                                                                                                                                                                                                                                                                                                                      Wizard.WizardStepnewStepThe step the Wizard is about to change to
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      System.BooleanTrue if the change is to be cancelled.
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      ProcessKey(KeyEvent)

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public override bool ProcessKey(KeyEvent kb)
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                                                      KeyEventkb
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      System.Boolean
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                      Events +

                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Cancelled

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +This event is raised when the user has cancelled the Wizard by pressin the Esc key. +To prevent a Modal Wizard from +closing, cancel the event by setting Cancel to `true` before returning from the event handler. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public event Action<Wizard.WizardButtonEventArgs> Cancelled
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Event Type
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      System.Action<Wizard.WizardButtonEventArgs>
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Finished

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +This event is raised when the Next/Finish button in the Wizard is clicked. The Next/Finish button is always +the last button in the array of Buttons passed to the Wizard constructor, if any. This event is only +raised if the CurrentStep is the last Step in the Wizard flow +(otherwise the Finished event is raised). +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public event Action<Wizard.WizardButtonEventArgs> Finished
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Event Type
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      System.Action<Wizard.WizardButtonEventArgs>
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      MovingBack

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +This event is raised when the Back button in the Wizard is clicked. The Back button is always +the first button in the array of Buttons passed to the Wizard constructor, if any. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public event Action<Wizard.WizardButtonEventArgs> MovingBack
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Event Type
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      System.Action<Wizard.WizardButtonEventArgs>
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      MovingNext

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +This event is raised when the Next/Finish button in the Wizard is clicked (or the user presses Enter). +The Next/Finish button is always the last button in the array of Buttons passed to the Wizard constructor, +if any. This event is only raised if the CurrentStep is the last Step in the Wizard flow +(otherwise the Finished event is raised). +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public event Action<Wizard.WizardButtonEventArgs> MovingNext
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Event Type
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      System.Action<Wizard.WizardButtonEventArgs>
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      StepChanged

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +This event is raised after the Wizard has changed the CurrentStep. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public event Action<Wizard.StepChangeEventArgs> StepChanged
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Event Type
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      System.Action<Wizard.StepChangeEventArgs>
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      StepChanging

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +This event is raised when the current CurrentStep) is about to change. Use Cancel +to abort the transition. +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                      public event Action<Wizard.StepChangeEventArgs> StepChanging
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Event Type
                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                      System.Action<Wizard.StepChangeEventArgs>
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.html b/docs/api/Terminal.Gui/Terminal.Gui.html new file mode 100644 index 0000000000..be82fa0988 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.html @@ -0,0 +1,710 @@ + + + + + + + + Namespace Terminal.Gui + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                        Namespace Terminal.Gui +

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Classes +

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Application

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +A static, singleton class providing the main application driver for Terminal.Gui apps. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Application.ResizedEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Event arguments for the Resized event. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Application.RunState

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Captures the execution state for the provided Toplevel view. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Autocomplete

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Renders an overlay on another view at a given point that allows selecting +from a range of 'autocomplete' options. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Border

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Draws a border, background, or both around another element. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Border.ToplevelContainer

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +A sealed Toplevel derived class to implement Border feature. +This is only a wrapper to get borders on a toplevel and is recommended using another +derived, like Window where is possible to have borders with or without +border line or spacing around. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Button

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Button is a View that provides an item that invokes an System.Action when activated by the user. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        CheckBox

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +The CheckBox View shows an on/off toggle that the user can set +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Clipboard

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Provides cut, copy, and paste support for the clipboard with OS interaction. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ClipboardBase

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Shared abstract class to enforce rules from the implementation of the IClipboard interface. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ColorPicker

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +The ColorPicker View Color picker. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Colors

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +The default ColorSchemes for the application. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ColorScheme

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Color scheme definitions, they cover some common scenarios and are used +typically in containers such as Window and FrameView to set the scheme that is used by all the +views contained inside. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ComboBox

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +ComboBox control +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ConsoleDriver

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +ConsoleDriver is an abstract class that defines the requirements for a console driver. +There are currently three implementations: Terminal.Gui.CursesDriver (for Unix and Mac), Terminal.Gui.WindowsDriver, and Terminal.Gui.NetDriver that uses the .NET Console API. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ContextMenu

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +A context menu window derived from MenuBar containing menu items +which can be opened in any position. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        DateField

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Simple Date editing View +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        DateTimeEventArgs<T>

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Defines the event arguments for DateChanged and TimeChanged events. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Dialog

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +The Dialog View is a Window that by default is centered and contains one +or more Buttons. It defaults to the Dialog color scheme and has a 1 cell padding around the edges. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Dim

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Dim properties of a View to control the position. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        FakeConsole

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        FakeDriver

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Implements a mock ConsoleDriver for unit testing +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        FakeMainLoop

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Mainloop intended to be used with the .NET System.Console API, and can +be used on Windows and Unix, it is cross platform but lacks things like +file descriptor monitoring. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        FileDialog

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Base class for the OpenDialog and the SaveDialog +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        FrameView

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +The FrameView is a container frame that draws a frame around the contents. It is similar to +a GroupBox in Windows. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        GraphView

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Control for rendering graphs (bar, scatter etc) +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        HexView

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +An hex viewer and editor View over a System.IO.Stream +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        HexView.HexViewEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Defines the event arguments for PositionChanged event. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        KeyEvent

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Describes a keyboard event. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        KeyModifiers

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Identifies the state of the "shift"-keys within a event. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Label

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +The Label View displays a string at a given position and supports multiple lines separated by newline characters. +Multi-line Labels support word wrap. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        LineView

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +A straight line control either horizontal or vertical +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ListView

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +ListView View renders a scrollable list of data where each item can be activated to perform an action. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ListViewItemEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +System.EventArgs for ListView events. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ListViewRowEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +System.EventArgs used by the RowRender event. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ListWrapper

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Implements an IListDataSource that renders arbitrary System.Collections.IList instances for ListView. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        MainLoop

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Simple main loop implementation that can be used to monitor +file descriptor, run timers and idle handlers. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        MainLoop.Timeout

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Provides data for timers running manipulation. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        MenuBar

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +The MenuBar provides a menu for Terminal.Gui applications. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        MenuBarItem

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +A MenuBarItem contains MenuBarItems or MenuItems. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        MenuClosingEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +An System.EventArgs which allows passing a cancelable menu closing event. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        MenuItem

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +A MenuItem has a title, an associated help text, and an action to execute on activation. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        MenuOpeningEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +An System.EventArgs which allows passing a cancelable menu opening event or replacing with a new MenuBarItem. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        MessageBox

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        OpenDialog

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +The OpenDialogprovides an interactive dialog box for users to select files or directories. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        PanelView

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +A container for single Child that will allow to drawn Border in +two ways. If UsePanelFrame the borders and the child will be accommodated in the available +panel size, otherwise the panel will be resized based on the child and borders thickness sizes. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Pos

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Describes the position of a View which can be an absolute value, a percentage, centered, or +relative to the ending dimension. Integer values are implicitly convertible to +an absolute Pos. These objects are created using the static methods Percent, +AnchorEnd, and Center. The Pos objects can be combined with the addition and +subtraction operators. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ProgressBar

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +A Progress Bar view that can indicate progress of an activity visually. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        RadioGroup

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +RadioGroup shows a group of radio labels, only one of those can be selected at a given time +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Responder

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Responder base class implemented by objects that want to participate on keyboard and mouse input. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        SaveDialog

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +The SaveDialog provides an interactive dialog box for users to pick a file to +save. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ScrollBarView

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ScrollView

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        SelectedItemChangedArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Event arguments for the SelectedItemChagned event. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ShortcutHelper

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Represents a helper to manipulate shortcut keys used on views. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        StackExtensions

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Extension of System.Collections.Generic.Stack<T> helper to work with specific System.Collections.Generic.IEqualityComparer<T> +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        StatusBar

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +A status bar is a View that snaps to the bottom of a Toplevel displaying set of StatusItems. +The StatusBar should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will +be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help. +So for each context must be a new instance of a statusbar. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        StatusItem

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +StatusItem objects are contained by StatusBar Views. +Each StatusItem has a title, a shortcut (hotkey), and an Action that will be invoked when the +Shortcut is pressed. +The Shortcut will be a global hotkey for the application in the current context of the screen. +The colour of the Title will be changed after each ~. +A Title set to `~F1~ Help` will render as *F1* using HotNormal and +*Help* as HotNormal. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TableView

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +View for tabular data based on a System.Data.DataTable. + +See TableView Deep Dive for more information. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TableView.CellActivatedEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Defines the event arguments for CellActivated event +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TableView.CellColorGetterArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Arguments for a TableView.CellColorGetterDelegate. Describes a cell for which a rendering +ColorScheme is being sought +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TableView.ColumnStyle

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Describes how to render a given column in a TableView including Alignment +and textual representation of cells (e.g. date formats) + +See TableView Deep Dive for more information. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TableView.RowColorGetterArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Arguments for TableView.RowColorGetterDelegate. Describes a row of data in a System.Data.DataTable +for which ColorScheme is sought. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TableView.SelectedCellChangedEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Defines the event arguments for SelectedCellChanged +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TableView.TableSelection

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Describes a selected region of the table +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TableView.TableStyle

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Defines rendering options that affect how the table is displayed. + +See TableView Deep Dive for more information. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TabView

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Control that hosts multiple sub views, presenting a single one at once +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TabView.Tab

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +A single tab in a TabView +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TabView.TabChangedEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Describes a change in SelectedTab +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TabView.TabStyle

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Describes render stylistic selections of a TabView +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TextChangingEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +An System.EventArgs which allows passing a cancelable new text value event. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TextField

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Single-line text entry View +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TextFieldAutocomplete

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Renders an overlay on another view at a given point that allows selecting +from a range of 'autocomplete' options. +An implementation on a TextField. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TextFormatter

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multiple lines, and word-based line wrap. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TextValidateField

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Text field that validates input through a ITextValidateProvider +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TextView

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Multi-line text editing View +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TextViewAutocomplete

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Renders an overlay on another view at a given point that allows selecting +from a range of 'autocomplete' options. +An implementation on a TextView. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TimeField

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Time editing View +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Toplevel

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Toplevel views can be modally executed. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ToplevelClosingEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +System.EventArgs implementation for the Closing event. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ToplevelComparer

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Implements the System.Collections.Generic.IComparer<T> to sort the Toplevel from the MdiChildes if needed. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ToplevelEqualityComparer

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Implements the System.Collections.Generic.IEqualityComparer<T> to comparing two Toplevel used by StackExtensions. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TreeView

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Convenience implementation of generic TreeView<T> for any tree were all nodes +implement ITreeNode. + +See TreeView Deep Dive for more information. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TreeView<T>

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Hierarchical tree view with expandable branches. Branch objects are dynamically determined +when expanded using a user defined ITreeBuilder<T> + +See TreeView Deep Dive for more information. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        View

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        View.FocusEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Defines the event arguments for Terminal.Gui.View.SetFocus(Terminal.Gui.View) +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        View.KeyEventEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Defines the event arguments for KeyEvent +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        View.LayoutEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Event arguments for the LayoutComplete event. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        View.MouseEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Specifies the event arguments for MouseEvent +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Window

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +A Toplevel View that draws a border around its Frame with a Title at the top. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Window.TitleEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +An System.EventArgs which allows passing a cancelable new Title value event. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Wizard

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step (Wizard.WizardStep) can host +arbitrary Views, much like a Dialog. Each step also has a pane for help text. Along the +bottom of the Wizard view are customizable buttons enabling the user to navigate forward and backward through the Wizard. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Wizard.StepChangeEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +System.EventArgs for Wizard.WizardStep events. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Wizard.WizardButtonEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +System.EventArgs for Wizard.WizardStep transition events. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Wizard.WizardStep

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Represents a basic step that is displayed in a Wizard. The Wizard.WizardStep view is divided horizontally in two. On the left is the +content view where Views can be added, On the right is the help for the step. +Set HelpText to set the help text. If the help text is empty the help pane will not +be shown. + +If there are no Views added to the WizardStep the HelpText (if not empty) will fill the wizard step. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Wizard.WizardStep.TitleEventArgs

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +An System.EventArgs which allows passing a cancelable new Title value event. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Structs +

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Attribute

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Attributes are used as elements that contain both a foreground and a background or platform specific features +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        MouseEvent

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Describes a mouse event +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Point

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        PointF

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Represents an ordered pair of x and y coordinates that define a point in a two-dimensional plane. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Rect

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Stores a set of four integers that represent the location and size of a rectangle +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        RectangleF

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Stores the location and size of a rectangular region. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Size

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Stores an ordered pair of integers, which specify a Height and Width. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        SizeF

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Represents the size of a rectangular region with an ordered pair of width and height. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Thickness

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Describes the thickness of a frame around a rectangle. Four System.Int32 values describe +the Left, Top, Right, and Bottom sides +of the rectangle, respectively. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Interfaces +

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        IAutocomplete

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Renders an overlay on another view at a given point that allows selecting +from a range of 'autocomplete' options. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        IClipboard

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Definition to interact with the OS clipboard. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        IListDataSource

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Implement IListDataSource to provide custom rendering for a ListView. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        IMainLoopDriver

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Public interface to create your own platform specific main loop driver. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ITreeView

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Interface for all non generic members of TreeView<T> + +See TreeView Deep Dive for more information. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Enums +

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        BorderStyle

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Specifies the border style for a View and to be used by the Border class. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Color

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Basic colors that can be used to set the foreground and background colors in console applications. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Command

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Actions which can be performed by the application or bound to keys in a View control. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ConsoleDriver.DiagnosticFlags

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Enables diagnostic functions +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        CursorVisibility

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Cursors Visibility that are displayed +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Dialog.ButtonAlignments

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Determines the horizontal alignment of the Dialog buttons. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        DisplayModeLayout

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Used for choose the display mode of this RadioGroup +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Key

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +The Key enumeration contains special encoding for some keys, but can also +encode all the unicode values that can be passed. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        LayoutStyle

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the +value from the Frame will be used, if the value is Computed, then the Frame +will be updated from the X, Y Pos objects and the Width and Height Dim objects. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        MenuItemCheckStyle

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Specifies how a MenuItem shows selection state. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        MouseFlags

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Mouse flags reported in MouseEvent. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        OpenDialog.OpenMode

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Determine which System.IO type to open. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ProgressBarFormat

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Specifies the format that a ProgressBar uses to indicate the visual presentation. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        ProgressBarStyle

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Specifies the style that a ProgressBar uses to indicate the progress of an operation. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TextAlignment

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Text alignment enumeration, controls how text is displayed. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TextDirection

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Text direction enumeration, controls how text is displayed. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        VerticalTextAlignment

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Vertical text alignment enumeration, controls how text is displayed. +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Delegates +

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TableView.CellColorGetterDelegate

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Delegate for providing color to TableView cells based on the value being rendered +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        TableView.RowColorGetterDelegate

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +Delegate for providing color for a whole row of a TableView +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/Terminal.Gui/Unix.Terminal.Curses.Event.html b/docs/api/Terminal.Gui/Unix.Terminal.Curses.Event.html new file mode 100644 index 0000000000..c4507e08ee --- /dev/null +++ b/docs/api/Terminal.Gui/Unix.Terminal.Curses.Event.html @@ -0,0 +1,247 @@ + + + + + + + + Enum Curses.Event + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                                          Enum Curses.Event +

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          Namespace: Unix.Terminal
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                          [Flags]
+public enum Event : long
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Fields +

                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                          NameDescription
                                                                                                                                                                                                                                                                                                                                          AllEvents
                                                                                                                                                                                                                                                                                                                                          Button1Clicked
                                                                                                                                                                                                                                                                                                                                          Button1DoubleClicked
                                                                                                                                                                                                                                                                                                                                          Button1Pressed
                                                                                                                                                                                                                                                                                                                                          Button1Released
                                                                                                                                                                                                                                                                                                                                          Button1TripleClicked
                                                                                                                                                                                                                                                                                                                                          Button2Clicked
                                                                                                                                                                                                                                                                                                                                          Button2DoubleClicked
                                                                                                                                                                                                                                                                                                                                          Button2Pressed
                                                                                                                                                                                                                                                                                                                                          Button2Released
                                                                                                                                                                                                                                                                                                                                          Button2TrippleClicked
                                                                                                                                                                                                                                                                                                                                          Button3Clicked
                                                                                                                                                                                                                                                                                                                                          Button3DoubleClicked
                                                                                                                                                                                                                                                                                                                                          Button3Pressed
                                                                                                                                                                                                                                                                                                                                          Button3Released
                                                                                                                                                                                                                                                                                                                                          Button3TripleClicked
                                                                                                                                                                                                                                                                                                                                          Button4Clicked
                                                                                                                                                                                                                                                                                                                                          Button4DoubleClicked
                                                                                                                                                                                                                                                                                                                                          Button4Pressed
                                                                                                                                                                                                                                                                                                                                          Button4Released
                                                                                                                                                                                                                                                                                                                                          Button4TripleClicked
                                                                                                                                                                                                                                                                                                                                          ButtonAlt
                                                                                                                                                                                                                                                                                                                                          ButtonCtrl
                                                                                                                                                                                                                                                                                                                                          ButtonShift
                                                                                                                                                                                                                                                                                                                                          ButtonWheeledDown
                                                                                                                                                                                                                                                                                                                                          ButtonWheeledUp
                                                                                                                                                                                                                                                                                                                                          ReportMousePosition
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/Terminal.Gui/Unix.Terminal.Curses.MouseEvent.html b/docs/api/Terminal.Gui/Unix.Terminal.Curses.MouseEvent.html new file mode 100644 index 0000000000..c1ee7b9efa --- /dev/null +++ b/docs/api/Terminal.Gui/Unix.Terminal.Curses.MouseEvent.html @@ -0,0 +1,259 @@ + + + + + + + + Struct Curses.MouseEvent + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                            Struct Curses.MouseEvent +

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + System.ValueType.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + System.ValueType.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + System.ValueType.ToString() +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Namespace: Unix.Terminal
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                            public struct MouseEvent
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Fields +

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            ButtonState

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                            public Curses.Event ButtonState
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Field Value
                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                            Curses.Event
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            ID

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                            public short ID
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Field Value
                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                            System.Int16
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            X

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                            public int X
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Field Value
                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                            System.Int32
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Y

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                            public int Y
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Field Value
                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                            System.Int32
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Z

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                            public int Z
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Field Value
                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                            System.Int32
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/Terminal.Gui/Unix.Terminal.Curses.Window.html b/docs/api/Terminal.Gui/Unix.Terminal.Curses.Window.html new file mode 100644 index 0000000000..e200da7a39 --- /dev/null +++ b/docs/api/Terminal.Gui/Unix.Terminal.Curses.Window.html @@ -0,0 +1,861 @@ + + + + + + + + Class Curses.Window + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                                                                                              Class Curses.Window +

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Inheritance
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Curses.Window
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Namespace: Unix.Terminal
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public class Window
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Fields +

                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Handle

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public readonly IntPtr Handle
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Field Value
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.IntPtr
                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Properties +

                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              Current

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public static Curses.Window Current { get; }
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              Curses.Window
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              Standard

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public static Curses.Window Standard { get; }
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              Curses.Window
                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Methods +

                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              addch(Char)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int addch(char ch)
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                              System.Charch
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              clearok(Boolean)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int clearok(bool bf)
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                              System.Booleanbf
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              idcok(Boolean)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public void idcok(bool bf)
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                              System.Booleanbf
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              idlok(Boolean)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int idlok(bool bf)
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                              System.Booleanbf
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              immedok(Boolean)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public void immedok(bool bf)
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                              System.Booleanbf
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              intrflush(Boolean)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int intrflush(bool bf)
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                              System.Booleanbf
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              keypad(Boolean)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int keypad(bool bf)
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                              System.Booleanbf
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              leaveok(Boolean)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int leaveok(bool bf)
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                              System.Booleanbf
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              meta(Boolean)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int meta(bool bf)
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                              System.Booleanbf
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              move(Int32, Int32)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int move(int line, int col)
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32line
                                                                                                                                                                                                                                                                                                                                              System.Int32col
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              notimeout(Boolean)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int notimeout(bool bf)
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                              System.Booleanbf
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              redrawwin()

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int redrawwin()
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              refresh()

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int refresh()
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              scrollok(Boolean)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int scrollok(bool bf)
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                              System.Booleanbf
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              setscrreg(Int32, Int32)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int setscrreg(int top, int bot)
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32top
                                                                                                                                                                                                                                                                                                                                              System.Int32bot
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              wnoutrefresh()

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int wnoutrefresh()
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              wrefresh()

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int wrefresh()
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                              wtimeout(Int32)

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                              public int wtimeout(int delay)
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32delay
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                              System.Int32
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/Terminal.Gui/Unix.Terminal.Curses.html b/docs/api/Terminal.Gui/Unix.Terminal.Curses.html new file mode 100644 index 0000000000..366160a78f --- /dev/null +++ b/docs/api/Terminal.Gui/Unix.Terminal.Curses.html @@ -0,0 +1,5642 @@ + + + + + + + + Class Curses + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                Class Curses +

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Curses
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Namespace: Unix.Terminal
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Assembly: Terminal.Gui.dll
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public class Curses
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Fields +

                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int A_BLINK = 524288
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                A_BOLD

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int A_BOLD = 2097152
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                A_DIM

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int A_DIM = 1048576
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                A_INVIS

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int A_INVIS = 8388608
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                A_NORMAL

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int A_NORMAL = 0
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                A_PROTECT

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int A_PROTECT = 16777216
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                A_REVERSE

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int A_REVERSE = 262144
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                A_STANDOUT

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int A_STANDOUT = 65536
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                A_UNDERLINE

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int A_UNDERLINE = 131072
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_BLOCK

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_BLOCK = 4194352
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_BOARD

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_BOARD = 4194408
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_BTEE

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_BTEE = 4194422
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_BULLET

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_BULLET = 4194430
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_CKBOARD

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_CKBOARD = 4194401
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_DARROW

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_DARROW = 4194350
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_DEGREE

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_DEGREE = 4194406
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_DIAMOND

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_DIAMOND = 4194400
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_HLINE

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_HLINE = 4194417
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_LANTERN

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_LANTERN = 4194409
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_LARROW

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_LARROW = 4194348
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_LLCORNER

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_LLCORNER = 4194413
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_LRCORNER

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_LRCORNER = 4194410
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_LTEE

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_LTEE = 4194420
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_PLMINUS

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_PLMINUS = 4194407
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_PLUS

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_PLUS = 4194414
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_RARROW

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_RARROW = 4194347
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_RTEE

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_RTEE = 4194421
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_S1

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_S1 = 4194415
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_S9

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_S9 = 4194419
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_TTEE

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_TTEE = 4194423
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_UARROW

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_UARROW = 4194349
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_ULCORNER

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_ULCORNER = 4194412
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_URCORNER

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_URCORNER = 4194411
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ACS_VLINE

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ACS_VLINE = 4194424
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                AltCtrlKeyEnd

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int AltCtrlKeyEnd = 532
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                AltCtrlKeyHome

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int AltCtrlKeyHome = 537
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                AltCtrlKeyNPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int AltCtrlKeyNPage = 552
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                AltCtrlKeyPPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int AltCtrlKeyPPage = 557
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                AltKeyDown

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int AltKeyDown = 523
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                AltKeyEnd

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int AltKeyEnd = 528
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                AltKeyHome

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int AltKeyHome = 533
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                AltKeyLeft

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int AltKeyLeft = 543
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                AltKeyNPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int AltKeyNPage = 548
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                AltKeyPPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int AltKeyPPage = 553
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                AltKeyRight

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int AltKeyRight = 558
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                AltKeyUp

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int AltKeyUp = 564
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                COLOR_BLACK

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int COLOR_BLACK = 0
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                COLOR_BLUE

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int COLOR_BLUE = 4
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                COLOR_CYAN

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int COLOR_CYAN = 6
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                COLOR_GRAY

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int COLOR_GRAY = 8
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                COLOR_GREEN

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int COLOR_GREEN = 2
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                COLOR_MAGENTA

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int COLOR_MAGENTA = 5
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                COLOR_RED

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int COLOR_RED = 1
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                COLOR_WHITE

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int COLOR_WHITE = 7
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                COLOR_YELLOW

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int COLOR_YELLOW = 3
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                CtrlKeyDown

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int CtrlKeyDown = 525
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                CtrlKeyEnd

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int CtrlKeyEnd = 530
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                CtrlKeyHome

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int CtrlKeyHome = 535
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                CtrlKeyLeft

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int CtrlKeyLeft = 545
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                CtrlKeyNPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int CtrlKeyNPage = 550
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                CtrlKeyPPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int CtrlKeyPPage = 555
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                CtrlKeyRight

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int CtrlKeyRight = 560
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                CtrlKeyUp

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int CtrlKeyUp = 566
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                DownEnd

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int DownEnd = 0
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ERR

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ERR = -1
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Home

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int Home = 0
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KEY_CODE_SEQ

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KEY_CODE_SEQ = 91
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KEY_CODE_YES

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KEY_CODE_YES = 256
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyAlt

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyAlt = 8192
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyBackspace

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyBackspace = 263
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyBackTab

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyBackTab = 353
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyDeleteChar

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyDeleteChar = 330
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyDown

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyDown = 258
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyEnd

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyEnd = 360
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyF1

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyF1 = 265
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyF10

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyF10 = 274
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyF11

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyF11 = 275
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyF12

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyF12 = 276
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyF2

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyF2 = 266
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyF3

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyF3 = 267
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyF4

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyF4 = 268
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyF5

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyF5 = 269
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyF6

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyF6 = 270
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyF7

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyF7 = 271
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyF8

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyF8 = 272
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyF9

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyF9 = 273
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyHome

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyHome = 262
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyInsertChar

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyInsertChar = 331
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyLeft

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyLeft = 260
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyMouse

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyMouse = 409
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyNPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyNPage = 338
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyPPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyPPage = 339
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyResize

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyResize = 410
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyRight

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyRight = 261
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyTab

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyTab = 9
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                KeyUp

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int KeyUp = 259
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                LeftRightUpNPagePPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int LeftRightUpNPagePPage = 0
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftAltKeyDown

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftAltKeyDown = 524
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftAltKeyEnd

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftAltKeyEnd = 529
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftAltKeyHome

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftAltKeyHome = 534
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftAltKeyLeft

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftAltKeyLeft = 544
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftAltKeyNPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftAltKeyNPage = 549
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftAltKeyPPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftAltKeyPPage = 554
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftAltKeyRight

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftAltKeyRight = 559
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftAltKeyUp

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftAltKeyUp = 565
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftCtrlKeyDown

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftCtrlKeyDown = 526
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftCtrlKeyEnd

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftCtrlKeyEnd = 531
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftCtrlKeyHome

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftCtrlKeyHome = 536
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftCtrlKeyLeft

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftCtrlKeyLeft = 546
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftCtrlKeyNPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftCtrlKeyNPage = 551
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftCtrlKeyPPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftCtrlKeyPPage = 556
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftCtrlKeyRight

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftCtrlKeyRight = 561
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftCtrlKeyUp

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftCtrlKeyUp = 567
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftKeyDown

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftKeyDown = 336
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftKeyEnd

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftKeyEnd = 386
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftKeyHome

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftKeyHome = 391
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftKeyLeft

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftKeyLeft = 393
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftKeyNPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftKeyNPage = 396
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftKeyPPage

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftKeyPPage = 398
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftKeyRight

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftKeyRight = 402
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                ShiftKeyUp

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int ShiftKeyUp = 337
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                TIOCGWINSZ

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int TIOCGWINSZ = 21523
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                TIOCGWINSZ_MAC

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public const int TIOCGWINSZ_MAC = 1074295912
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Field Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Properties +

                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                ColorPairs

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int ColorPairs { get; }
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                Cols

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int Cols { get; }
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                HasColors

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static bool HasColors { get; }
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                LC_ALL

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int LC_ALL { get; }
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                Lines

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int Lines { get; }
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Methods +

                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                addch(Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int addch(int ch)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32ch
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                addstr(String, Object[])

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int addstr(string format, params object[] args)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Stringformat
                                                                                                                                                                                                                                                                                                                                                System.Object[]args
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                addwstr(String)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int addwstr(string s)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Strings
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                attroff(Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int attroff(int attrs)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32attrs
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                attron(Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int attron(int attrs)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32attrs
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                attrset(Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int attrset(int attrs)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32attrs
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                cbreak()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int cbreak()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                CheckWinChange()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static bool CheckWinChange()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                clearok(IntPtr, Boolean)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int clearok(IntPtr win, bool bf)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                System.Booleanbf
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                COLOR_PAIRS()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int COLOR_PAIRS()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                ColorPair(Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int ColorPair(int n)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32n
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                curs_set(Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int curs_set(int visibility)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32visibility
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                def_prog_mode()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int def_prog_mode()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                def_shell_mode()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int def_shell_mode()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                doupdate()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int doupdate()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                echo()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int echo()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                endwin()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int endwin()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                flushinp()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int flushinp()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                get_wch(out Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int get_wch(out int sequence)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32sequence
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                getch()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int getch()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                getmouse(out Curses.MouseEvent)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static uint getmouse(out Curses.MouseEvent ev)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                Curses.MouseEventev
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.UInt32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                halfdelay(Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int halfdelay(int t)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32t
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                has_colors()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static bool has_colors()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                idcok(IntPtr, Boolean)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static void idcok(IntPtr win, bool bf)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                System.Booleanbf
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                idlok(IntPtr, Boolean)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int idlok(IntPtr win, bool bf)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                System.Booleanbf
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                immedok(IntPtr, Boolean)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static void immedok(IntPtr win, bool bf)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                System.Booleanbf
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                init_pair(Int16, Int16, Int16)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int init_pair(short pair, short f, short b)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int16pair
                                                                                                                                                                                                                                                                                                                                                System.Int16f
                                                                                                                                                                                                                                                                                                                                                System.Int16b
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                InitColorPair(Int16, Int16, Int16)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int InitColorPair(short pair, short foreground, short background)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int16pair
                                                                                                                                                                                                                                                                                                                                                System.Int16foreground
                                                                                                                                                                                                                                                                                                                                                System.Int16background
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                initscr()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static Curses.Window initscr()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                Curses.Window
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                intrflush(IntPtr, Boolean)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int intrflush(IntPtr win, bool bf)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                System.Booleanbf
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                is_term_resized(Int32, Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static bool is_term_resized(int lines, int columns)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32lines
                                                                                                                                                                                                                                                                                                                                                System.Int32columns
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                IsAlt(Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int IsAlt(int key)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32key
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                isendwin()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static bool isendwin()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Boolean
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                keypad(IntPtr, Boolean)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int keypad(IntPtr win, bool bf)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                System.Booleanbf
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                leaveok(IntPtr, Boolean)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int leaveok(IntPtr win, bool bf)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                System.Booleanbf
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                meta(IntPtr, Boolean)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int meta(IntPtr win, bool bf)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                System.Booleanbf
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                mouseinterval(Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int mouseinterval(int interval)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32interval
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                mousemask(Curses.Event, out Curses.Event)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static Curses.Event mousemask(Curses.Event newmask, out Curses.Event oldmask)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                Curses.Eventnewmask
                                                                                                                                                                                                                                                                                                                                                Curses.Eventoldmask
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                Curses.Event
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                move(Int32, Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int move(int line, int col)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32line
                                                                                                                                                                                                                                                                                                                                                System.Int32col
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                mvaddch(Int32, Int32, Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int mvaddch(int y, int x, int ch)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32y
                                                                                                                                                                                                                                                                                                                                                System.Int32x
                                                                                                                                                                                                                                                                                                                                                System.Int32ch
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                mvaddwstr(Int32, Int32, String)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int mvaddwstr(int y, int x, string s)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32y
                                                                                                                                                                                                                                                                                                                                                System.Int32x
                                                                                                                                                                                                                                                                                                                                                System.Strings
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                mvgetch(Int32, Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int mvgetch(int y, int x)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32y
                                                                                                                                                                                                                                                                                                                                                System.Int32x
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                nl()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int nl()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                nocbreak()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int nocbreak()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                noecho()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int noecho()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                nonl()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int nonl()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                noqiflush()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static void noqiflush()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                noraw()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int noraw()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                notimeout(IntPtr, Boolean)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int notimeout(IntPtr win, bool bf)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                System.Booleanbf
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                qiflush()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static void qiflush()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                raw()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int raw()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                redrawwin(IntPtr)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int redrawwin(IntPtr win)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                refresh()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int refresh()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                reset_prog_mode()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int reset_prog_mode()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                reset_shell_mode()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int reset_shell_mode()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                resetty()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int resetty()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                resize_term(Int32, Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int resize_term(int lines, int columns)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32lines
                                                                                                                                                                                                                                                                                                                                                System.Int32columns
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                resizeterm(Int32, Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int resizeterm(int lines, int columns)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32lines
                                                                                                                                                                                                                                                                                                                                                System.Int32columns
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                savetty()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int savetty()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                scrollok(IntPtr, Boolean)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int scrollok(IntPtr win, bool bf)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                System.Booleanbf
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                setlocale(Int32, String)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static extern int setlocale(int cate, string locale)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32cate
                                                                                                                                                                                                                                                                                                                                                System.Stringlocale
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                setscrreg(Int32, Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int setscrreg(int top, int bot)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32top
                                                                                                                                                                                                                                                                                                                                                System.Int32bot
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                start_color()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int start_color()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                StartColor()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int StartColor()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                timeout(Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int timeout(int delay)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32delay
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                typeahead(IntPtr)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int typeahead(IntPtr fd)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrfd
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                ungetch(Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int ungetch(int ch)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32ch
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                ungetmouse(ref Curses.MouseEvent)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static uint ungetmouse(ref Curses.MouseEvent ev)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                Curses.MouseEventev
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.UInt32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                use_default_colors()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int use_default_colors()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                use_env(Boolean)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static void use_env(bool f)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.Booleanf
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                UseDefaultColors()

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int UseDefaultColors()
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                waddch(IntPtr, Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int waddch(IntPtr win, int ch)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                System.Int32ch
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                wmove(IntPtr, Int32, Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int wmove(IntPtr win, int line, int col)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                System.Int32line
                                                                                                                                                                                                                                                                                                                                                System.Int32col
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                wnoutrefresh(IntPtr)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int wnoutrefresh(IntPtr win)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                wrefresh(IntPtr)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int wrefresh(IntPtr win)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                wsetscrreg(IntPtr, Int32, Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int wsetscrreg(IntPtr win, int top, int bot)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                System.Int32top
                                                                                                                                                                                                                                                                                                                                                System.Int32bot
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                wtimeout(IntPtr, Int32)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                public static int wtimeout(IntPtr win, int delay)
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                System.IntPtrwin
                                                                                                                                                                                                                                                                                                                                                System.Int32delay
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                System.Int32
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/Terminal.Gui/Unix.Terminal.html b/docs/api/Terminal.Gui/Unix.Terminal.html new file mode 100644 index 0000000000..60e3ceea7e --- /dev/null +++ b/docs/api/Terminal.Gui/Unix.Terminal.html @@ -0,0 +1,134 @@ + + + + + + + + Namespace Unix.Terminal + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/Terminal.Gui/toc.html b/docs/api/Terminal.Gui/toc.html new file mode 100644 index 0000000000..0d2a71f59e --- /dev/null +++ b/docs/api/Terminal.Gui/toc.html @@ -0,0 +1,543 @@ + +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/api/UICatalog/UICatalog.NumberToWords.html b/docs/api/UICatalog/UICatalog.NumberToWords.html new file mode 100644 index 0000000000..0b6d049d34 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.NumberToWords.html @@ -0,0 +1,237 @@ + + + + + + + + Class NumberToWords + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                    Class NumberToWords +

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    NumberToWords
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    Namespace: UICatalog
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                    public static class NumberToWords
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                    Convert(Int64)

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                    public static string Convert(long i)
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                    System.Int64i
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                                    System.String
                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                    ConvertAmount(Double)

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                    public static string ConvertAmount(double amount)
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                    System.Doubleamount
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                                    System.String
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenario.ScenarioCategory.html b/docs/api/UICatalog/UICatalog.Scenario.ScenarioCategory.html new file mode 100644 index 0000000000..8c79d9865a --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenario.ScenarioCategory.html @@ -0,0 +1,402 @@ + + + + + + + + Class Scenario.ScenarioCategory + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                                                                      Class Scenario.ScenarioCategory +

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Defines the category names used to catagorize a Scenario

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      System.Attribute
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Scenario.ScenarioCategory
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.Assembly) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.Module) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.IsDefaultAttribute() +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.IsDefined(System.Reflection.Assembly, System.Type) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.IsDefined(System.Reflection.Module, System.Type) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.Match(System.Object) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Attribute.TypeId +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Namespace: UICatalog
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                      [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
+public class ScenarioCategory : Attribute
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Constructors +

                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                      ScenarioCategory(String)

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                      public ScenarioCategory(string Name)
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                      System.StringName
                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Properties +

                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                      Name

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Category Name

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                      public string Name { get; set; }
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                                      System.String
                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Methods +

                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                      GetCategories(Type)

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Static helper function to get the Scenario Categories given a Type

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                      public static List<string> GetCategories(Type t)
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                      System.Typet
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                                      System.Collections.Generic.List<System.String>

                                                                                                                                                                                                                                                                                                                                                      list of category names

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                      GetName(Type)

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Static helper function to get the Scenario Name given a Type

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                      public static string GetName(Type t)
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                      System.Typet
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                                      System.String

                                                                                                                                                                                                                                                                                                                                                      Name of the category

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html b/docs/api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html new file mode 100644 index 0000000000..ef88ac9992 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html @@ -0,0 +1,429 @@ + + + + + + + + Class Scenario.ScenarioMetadata + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                        Class Scenario.ScenarioMetadata +

                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Defines the metadata (Name and Description) for a Scenario

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        System.Attribute
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Scenario.ScenarioMetadata
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.Assembly) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.Module) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.IsDefaultAttribute() +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.IsDefined(System.Reflection.Assembly, System.Type) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.IsDefined(System.Reflection.Module, System.Type) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.Match(System.Object) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Attribute.TypeId +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Namespace: UICatalog
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                        [AttributeUsage(AttributeTargets.Class)]
+public class ScenarioMetadata : Attribute
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Constructors +

                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                        ScenarioMetadata(String, String)

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                        public ScenarioMetadata(string Name, string Description)
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                        System.StringName
                                                                                                                                                                                                                                                                                                                                                        System.StringDescription
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Properties +

                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                        Description

                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Scenario Description

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                        public string Description { get; set; }
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                        System.String
                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                        Name

                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Scenario Name

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                        public string Name { get; set; }
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Property Value
                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                        System.String
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                        GetDescription(Type)

                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Static helper function to get the Scenario Description given a Type

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                        public static string GetDescription(Type t)
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                        System.Typet
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                        System.String
                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                        GetName(Type)

                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Static helper function to get the Scenario Name given a Type

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                        public static string GetName(Type t)
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                        System.Typet
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                        System.String
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenario.html b/docs/api/UICatalog/UICatalog.Scenario.html new file mode 100644 index 0000000000..027008dbd6 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenario.html @@ -0,0 +1,547 @@ + + + + + + + + Class Scenario + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                                                          Class Scenario +

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Base class for each demo/scenario.

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          + To define a new scenario: +

                                                                                                                                                                                                                                                                                                                                                          1. Create a new .cs file in the Scenarios directory that derives from Scenario.
                                                                                                                                                                                                                                                                                                                                                          2. Annotate the Scenario derived class with a Scenario.ScenarioMetadata attribute specifying the scenario's name and description.
                                                                                                                                                                                                                                                                                                                                                          3. Add one or more Scenario.ScenarioCategory attributes to the class specifying which categories the scenario belongs to. If you don't specify a category the scenario will show up in "_All".
                                                                                                                                                                                                                                                                                                                                                          4. Implement the Setup() override which will be called when a user selects the scenario to run.
                                                                                                                                                                                                                                                                                                                                                          5. Optionally, implement the Init(Toplevel, ColorScheme) and/or Run() overrides to provide a custom implementation.
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          +The UI Catalog program uses reflection to find all scenarios and adds them to the +ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it. / +

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Scenario
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          AllViewsTester
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          AutoSizeAndDirectionText
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          BackgroundWorkerCollection
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          BasicColors
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Borders
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          BordersComparisons
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          BordersOnFrameView
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          BordersOnToplevel
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          BordersOnWindow
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Buttons
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          CharacterMap
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          ClassExplorer
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Clipping
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          ColorPickers
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          ComboBoxIteration
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          ComputedLayout
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          ContextMenus
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          CsvEditor
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Dialogs
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          DynamicMenuBar
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          DynamicStatusBar
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Editor
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          GraphViewExample
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          HexEditor
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          InteractiveTree
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          InvertColors
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Keys
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          LabelsAsLabels
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          LineViewExample
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          ListsAndCombos
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          ListViewWithSelection
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          MessageBoxes
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Mouse
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          MultiColouredTable
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          MyScenario
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Notepad
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Progress
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          ProgressBarStyles
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          RuneWidthGreaterThanOne
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Scrolling
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          SendKeys
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          SingleBackgroundWorker
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          SyntaxHighlighting
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          TableEditor
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          TabViewExample
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Text
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          TextAlignments
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          TextAlignmentsAndDirections
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          TextFormatterDemo
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          TextViewAutocompletePopup
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Threading
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          TimeAndDate
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          TreeUseCases
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          TreeViewFileSystem
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          UnicodeInMenu
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          WindowsAndFrameViews
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          WizardAsView
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Wizards
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Implements
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          System.IDisposable
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Namespace: UICatalog
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                          public class Scenario : IDisposable
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Examples
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          The example below is provided in the Scenarios directory as a generic sample that can be copied and re-named:

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          using Terminal.Gui;
+
+namespace UICatalog {
+    [ScenarioMetadata (Name: "Generic", Description: "Generic sample - A template for creating new Scenarios")]
+    [ScenarioCategory ("Controls")]
+    class MyScenario : Scenario {
+        public override void Setup ()
+        {
+            // Put your scenario code here, e.g.
+            Win.Add (new Button ("Press me!") {
+                X = Pos.Center (),
+                Y = Pos.Center (),
+                Clicked = () => MessageBox.Query (20, 7, "Hi", "Neat?", "Yes", "No")
+            });
+        }
+    }
+}
                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          Properties +

                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          Top

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          The Top level for the Scenario. This should be set to Top in most cases.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                          public Toplevel Top { get; set; }
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                          Toplevel
                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          Win

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          The Window for the Scenario. This should be set within the Top in most cases.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                          public Window Win { get; set; }
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                          Window
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          Dispose()

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                          public void Dispose()
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          Dispose(Boolean)

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                          protected virtual void Dispose(bool disposing)
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                          System.Booleandisposing
                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          GetCategories()

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Helper function to get the list of categories a Scenario belongs to (defined in Scenario.ScenarioCategory)

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                          public List<string> GetCategories()
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                          System.Collections.Generic.List<System.String>

                                                                                                                                                                                                                                                                                                                                                          list of category names

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          GetDerivedClasses<T>()

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Returns an instance of each Scenario defined in the project. +https://stackoverflow.com/questions/5411694/get-all-inherited-classes-of-an-abstract-class

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                          public static List<Type> GetDerivedClasses<T>()
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                          System.Collections.Generic.List<System.Type>
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Type Parameters
                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                          NameDescription
                                                                                                                                                                                                                                                                                                                                                          T
                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          GetDescription()

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Helper to get the Scenario Description (defined in Scenario.ScenarioMetadata)

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                          public string GetDescription()
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                          System.String
                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          GetName()

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Helper to get the Scenario Name (defined in Scenario.ScenarioMetadata)

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                          public string GetName()
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                          System.String
                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          Init(Toplevel, ColorScheme)

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Helper that provides the default Window implementation with a frame and +label showing the name of the Scenario and logic to exit back to +the Scenario picker UI. +Override Init(Toplevel, ColorScheme) to provide any Toplevel behavior needed.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                          public virtual void Init(Toplevel top, ColorScheme colorScheme)
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                          Topleveltop

                                                                                                                                                                                                                                                                                                                                                          The Toplevel created by the UI Catalog host.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          ColorSchemecolorScheme

                                                                                                                                                                                                                                                                                                                                                          The colorscheme to use.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Remarks
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          +The base implementation calls Init(ConsoleDriver, IMainLoopDriver), sets Top to the passed in Toplevel, creates a Window for Win and adds it to Top. +

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          +Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. +

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          RequestStop()

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Stops the scenario. Override to change shutdown behavior for the Scenario.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                          public virtual void RequestStop()
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          Run()

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Runs the Scenario. Override to start the Scenario using a Toplevel different than Top.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                          public virtual void Run()
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Remarks
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Overrides that do not call the base.Run(), must call Shutdown() before returning.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          Setup()

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Override this to implement the Scenario setup logic (create controls, etc...).

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                          public virtual void Setup()
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Remarks
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          This is typically the best place to put scenario logic code.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                          ToString()

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                          public override string ToString()
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                          System.String
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          System.Object.ToString()
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Implements

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.AllViewsTester.html b/docs/api/UICatalog/UICatalog.Scenarios.AllViewsTester.html new file mode 100644 index 0000000000..2da36397f2 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.AllViewsTester.html @@ -0,0 +1,249 @@ + + + + + + + + Class AllViewsTester + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                            Class AllViewsTester +

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Scenario
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            AllViewsTester
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Implements
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            System.IDisposable
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                            [Scenario.ScenarioMetadata("All Views Tester", "Provides a test UI for all classes derived from View.")]
+[Scenario.ScenarioCategory("Layout")]
+[Scenario.ScenarioCategory("Tests")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+public class AllViewsTester : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                            Init(Toplevel, ColorScheme)

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                            public override void Init(Toplevel top, ColorScheme colorScheme)
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                            Topleveltop
                                                                                                                                                                                                                                                                                                                                                            ColorSchemecolorScheme
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                            Run()

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                            public override void Run()
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                            Setup()

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                            public override void Setup()
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.AutoSizeAndDirectionText.html b/docs/api/UICatalog/UICatalog.Scenarios.AutoSizeAndDirectionText.html new file mode 100644 index 0000000000..665238bcd8 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.AutoSizeAndDirectionText.html @@ -0,0 +1,211 @@ + + + + + + + + Class AutoSizeAndDirectionText + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                                                                                                              Class AutoSizeAndDirectionText +

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              Inheritance
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              Scenario
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              AutoSizeAndDirectionText
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              Implements
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              System.IDisposable
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                              [Scenario.ScenarioMetadata("Text Direction and AutoSize", "Demos TextFormatter Direction and View AutoSize.")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+public class AutoSizeAndDirectionText : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Methods +

                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                              Setup()

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                              public override void Setup()
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              Overrides
                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                              Implements

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.BackgroundWorkerCollection.html b/docs/api/UICatalog/UICatalog.Scenarios.BackgroundWorkerCollection.html new file mode 100644 index 0000000000..0c94f3fbd1 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.BackgroundWorkerCollection.html @@ -0,0 +1,243 @@ + + + + + + + + Class BackgroundWorkerCollection + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                Class BackgroundWorkerCollection +

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                Scenario
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                BackgroundWorkerCollection
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                Implements
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                [Scenario.ScenarioMetadata("BackgroundWorker Collection", "A persisting multi Toplevel BackgroundWorker threading")]
+[Scenario.ScenarioCategory("Threading")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+[Scenario.ScenarioCategory("Dialogs")]
+[Scenario.ScenarioCategory("Controls")]
+public class BackgroundWorkerCollection : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Methods +

                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                Init(Toplevel, ColorScheme)

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                public override void Init(Toplevel top, ColorScheme colorScheme)
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                Topleveltop
                                                                                                                                                                                                                                                                                                                                                                ColorSchemecolorScheme
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                Overrides
                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                Run()

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                public override void Run()
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                Overrides
                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                Implements

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.BasicColors.html b/docs/api/UICatalog/UICatalog.Scenarios.BasicColors.html new file mode 100644 index 0000000000..a7aa2b7073 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.BasicColors.html @@ -0,0 +1,212 @@ + + + + + + + + Class BasicColors + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                                                                  Class BasicColors +

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  Scenario
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  BasicColors
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  Implements
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                  [Scenario.ScenarioMetadata("Basic Colors", "Show all basic colors.")]
+[Scenario.ScenarioCategory("Colors")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+public class BasicColors : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Methods +

                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                  Setup()

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                  public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                  Implements

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.Borders.html b/docs/api/UICatalog/UICatalog.Scenarios.Borders.html new file mode 100644 index 0000000000..2c464cf88f --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.Borders.html @@ -0,0 +1,212 @@ + + + + + + + + Class Borders + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                    Class Borders +

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    Scenario
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    Borders
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                    [Scenario.ScenarioMetadata("Borders with/without PanelView", "Demonstrate with/without PanelView borders manipulation.")]
+[Scenario.ScenarioCategory("Layout")]
+[Scenario.ScenarioCategory("Borders")]
+public class Borders : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                    Setup()

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                    public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.BordersComparisons.html b/docs/api/UICatalog/UICatalog.Scenarios.BordersComparisons.html new file mode 100644 index 0000000000..1565cfb1cf --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.BordersComparisons.html @@ -0,0 +1,241 @@ + + + + + + + + Class BordersComparisons + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                                                                                      Class BordersComparisons +

                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Scenario
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      BordersComparisons
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Implements
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                      [Scenario.ScenarioMetadata("Borders Comparisons", "Compares Window, Toplevel and FrameView borders.")]
+[Scenario.ScenarioCategory("Layout")]
+[Scenario.ScenarioCategory("Borders")]
+public class BordersComparisons : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                      Methods +

                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                      Init(Toplevel, ColorScheme)

                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                      public override void Init(Toplevel top, ColorScheme colorScheme)
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                      Topleveltop
                                                                                                                                                                                                                                                                                                                                                                      ColorSchemecolorScheme
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                                                                                      Run()

                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                      public override void Run()
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.BordersOnFrameView.html b/docs/api/UICatalog/UICatalog.Scenarios.BordersOnFrameView.html new file mode 100644 index 0000000000..205af732f7 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.BordersOnFrameView.html @@ -0,0 +1,212 @@ + + + + + + + + Class BordersOnFrameView + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                        Class BordersOnFrameView +

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        Scenario
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        BordersOnFrameView
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        Implements
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                        [Scenario.ScenarioMetadata("Borders on FrameView", "Demonstrate FrameView borders manipulation.")]
+[Scenario.ScenarioCategory("Layout")]
+[Scenario.ScenarioCategory("Borders")]
+public class BordersOnFrameView : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                        Setup()

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                        public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.BordersOnToplevel.html b/docs/api/UICatalog/UICatalog.Scenarios.BordersOnToplevel.html new file mode 100644 index 0000000000..edd0b8acea --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.BordersOnToplevel.html @@ -0,0 +1,212 @@ + + + + + + + + Class BordersOnToplevel + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                                                                          Class BordersOnToplevel +

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          Scenario
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          BordersOnToplevel
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          Implements
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                          [Scenario.ScenarioMetadata("Borders on Toplevel", "Demonstrates Toplevel borders manipulation.")]
+[Scenario.ScenarioCategory("Layout")]
+[Scenario.ScenarioCategory("Borders")]
+public class BordersOnToplevel : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                          Setup()

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                          public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                          Implements

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.BordersOnWindow.html b/docs/api/UICatalog/UICatalog.Scenarios.BordersOnWindow.html new file mode 100644 index 0000000000..0f196c21c9 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.BordersOnWindow.html @@ -0,0 +1,212 @@ + + + + + + + + Class BordersOnWindow + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                            Class BordersOnWindow +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            Scenario
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            BordersOnWindow
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            Implements
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                            [Scenario.ScenarioMetadata("Borders on Window", "Demonstrates Window borders manipulation.")]
+[Scenario.ScenarioCategory("Layout")]
+[Scenario.ScenarioCategory("Borders")]
+public class BordersOnWindow : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                            Setup()

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                            public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.Buttons.html b/docs/api/UICatalog/UICatalog.Scenarios.Buttons.html new file mode 100644 index 0000000000..3a9c2fa80c --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.Buttons.html @@ -0,0 +1,212 @@ + + + + + + + + Class Buttons + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                                                                                                                              Class Buttons +

                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Inheritance
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Scenario
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Buttons
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Implements
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                              [Scenario.ScenarioMetadata("Buttons", "Demonstrates all sorts of Buttons.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Layout")]
+public class Buttons : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Methods +

                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                              Setup()

                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                              public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Overrides
                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                              Implements

                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.CharacterMap.html b/docs/api/UICatalog/UICatalog.Scenarios.CharacterMap.html new file mode 100644 index 0000000000..84b3be84bb --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.CharacterMap.html @@ -0,0 +1,226 @@ + + + + + + + + Class CharacterMap + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                Class CharacterMap +

                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                This Scenario demonstrates building a custom control (a class deriving from View) that:

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                • Provides a simple "Character Map" application (like Windows' charmap.exe).
                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                • Helps test unicode character rendering in Terminal.Gui
                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                • Illustrates how to use ScrollView to do infinite scrolling
                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                Scenario
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                CharacterMap
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                Implements
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                [Scenario.ScenarioMetadata("Character Map", "A Unicode character set viewier built as a custom control using the ScrollView control.")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("ScrollView")]
+public class CharacterMap : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                Methods +

                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                Run()

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                public override void Run()
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                Overrides
                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                Setup()

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                Overrides
                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                Implements

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.ClassExplorer.html b/docs/api/UICatalog/UICatalog.Scenarios.ClassExplorer.html new file mode 100644 index 0000000000..5ee420fef3 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.ClassExplorer.html @@ -0,0 +1,212 @@ + + + + + + + + Class ClassExplorer + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                                                                                  Class ClassExplorer +

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Scenario
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  ClassExplorer
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Implements
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                  [Scenario.ScenarioMetadata("Class Explorer", "Tree view explorer for classes by namespace based on TreeView.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("TreeView")]
+public class ClassExplorer : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  Methods +

                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                  Setup()

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                  public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                  Implements

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.Clipping.html b/docs/api/UICatalog/UICatalog.Scenarios.Clipping.html new file mode 100644 index 0000000000..e959eeffa2 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.Clipping.html @@ -0,0 +1,240 @@ + + + + + + + + Class Clipping + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                    Class Clipping +

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Scenario
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Clipping
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                    [Scenario.ScenarioMetadata("Clipping", "Used to test that things clip correctly")]
+[Scenario.ScenarioCategory("Tests")]
+public class Clipping : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                    Init(Toplevel, ColorScheme)

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                    public override void Init(Toplevel top, ColorScheme colorScheme)
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                    Topleveltop
                                                                                                                                                                                                                                                                                                                                                                                    ColorSchemecolorScheme
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                    Setup()

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                    public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.ColorPickers.html b/docs/api/UICatalog/UICatalog.Scenarios.ColorPickers.html new file mode 100644 index 0000000000..a9c6375da0 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.ColorPickers.html @@ -0,0 +1,213 @@ + + + + + + + + Class ColorPickers + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                                                                                                      Class ColorPickers +

                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      Scenario
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      ColorPickers
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      Implements
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                      [Scenario.ScenarioMetadata("Color Picker", "Color Picker.")]
+[Scenario.ScenarioCategory("Colors")]
+[Scenario.ScenarioCategory("Controls")]
+public class ColorPickers : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Methods +

                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                      Setup()

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Setup the scenario.

                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                      public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.ComboBoxIteration.html b/docs/api/UICatalog/UICatalog.Scenarios.ComboBoxIteration.html new file mode 100644 index 0000000000..b04885f5eb --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.ComboBoxIteration.html @@ -0,0 +1,212 @@ + + + + + + + + Class ComboBoxIteration + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                        Class ComboBoxIteration +

                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        Scenario
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        ComboBoxIteration
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        Implements
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                        [Scenario.ScenarioMetadata("ComboBoxIteration", "ComboBox iteration.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("ComboBox")]
+public class ComboBoxIteration : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                        Setup()

                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                        public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.ComputedLayout.html b/docs/api/UICatalog/UICatalog.Scenarios.ComputedLayout.html new file mode 100644 index 0000000000..cbb56e8326 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.ComputedLayout.html @@ -0,0 +1,222 @@ + + + + + + + + Class ComputedLayout + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                                                                                          Class ComputedLayout +

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          This Scenario demonstrates how to use Termina.gui's Dim and Pos Layout System. +[x] - Using Dim.Fill to fill a window +[x] - Using Dim.Fill and Dim.Pos to automatically align controls based on an initial control +[ ] - ...

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          Scenario
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          ComputedLayout
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          Implements
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                          [Scenario.ScenarioMetadata("Computed Layout", "Demonstrates the Computed (Dim and Pos) Layout System.")]
+[Scenario.ScenarioCategory("Layout")]
+public class ComputedLayout : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                          Run()

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                          public override void Run()
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                                                                                          Setup()

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                          public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                          Implements

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.ContextMenus.html b/docs/api/UICatalog/UICatalog.Scenarios.ContextMenus.html new file mode 100644 index 0000000000..8c838fe180 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.ContextMenus.html @@ -0,0 +1,211 @@ + + + + + + + + Class ContextMenus + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                            Class ContextMenus +

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            Scenario
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            ContextMenus
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            Implements
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                            [Scenario.ScenarioMetadata("ContextMenus", "Context Menu Sample.")]
+[Scenario.ScenarioCategory("Menus")]
+public class ContextMenus : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                            Setup()

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                            public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.CsvEditor.html b/docs/api/UICatalog/UICatalog.Scenarios.CsvEditor.html new file mode 100644 index 0000000000..3d5e4e164d --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.CsvEditor.html @@ -0,0 +1,217 @@ + + + + + + + + Class CsvEditor + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                                                                                                                                              Class CsvEditor +

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              Inheritance
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              Scenario
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              CsvEditor
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              Implements
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                              [Scenario.ScenarioMetadata("Csv Editor", "Open and edit simple CSV files using the TableView class.")]
+[Scenario.ScenarioCategory("TableView")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Dialogs")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+[Scenario.ScenarioCategory("Dialogs")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+[Scenario.ScenarioCategory("Files and IO")]
+public class CsvEditor : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Methods +

                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                              Setup()

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                              public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              Overrides
                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                              Implements

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.Dialogs.html b/docs/api/UICatalog/UICatalog.Scenarios.Dialogs.html new file mode 100644 index 0000000000..28933b9a0a --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.Dialogs.html @@ -0,0 +1,211 @@ + + + + + + + + Class Dialogs + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                                Class Dialogs +

                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                Scenario
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                Dialogs
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                Implements
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                [Scenario.ScenarioMetadata("Dialogs", "Demonstrates how to the Dialog class")]
+[Scenario.ScenarioCategory("Dialogs")]
+public class Dialogs : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Methods +

                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                Setup()

                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                Overrides
                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                Implements

                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.Binding.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.Binding.html new file mode 100644 index 0000000000..a2697d80ee --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.Binding.html @@ -0,0 +1,296 @@ + + + + + + + + Class DynamicMenuBar.Binding + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                                                                                                  Class DynamicMenuBar.Binding +

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  DynamicMenuBar.Binding
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                  public class Binding
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Constructors +

                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                  Binding(View, String, View, String, DynamicMenuBar.IValueConverter)

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                  public Binding(View source, string sourcePropertyName, View target, string targetPropertyName, DynamicMenuBar.IValueConverter valueConverter = null)
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                  Viewsource
                                                                                                                                                                                                                                                                                                                                                                                                  System.StringsourcePropertyName
                                                                                                                                                                                                                                                                                                                                                                                                  Viewtarget
                                                                                                                                                                                                                                                                                                                                                                                                  System.StringtargetPropertyName
                                                                                                                                                                                                                                                                                                                                                                                                  DynamicMenuBar.IValueConvertervalueConverter
                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Properties +

                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                  Source

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                  public View Source { get; }
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                  View
                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                  SourcePropertyName

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                  public string SourcePropertyName { get; }
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                  System.String
                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                  Target

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                  public View Target { get; }
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                  View
                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                  TargetPropertyName

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                  public string TargetPropertyName { get; }
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Property Value
                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                  System.String
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuBarDetails.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuBarDetails.html new file mode 100644 index 0000000000..4372f36e9f --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuBarDetails.html @@ -0,0 +1,949 @@ + + + + + + + + Class DynamicMenuBar.DynamicMenuBarDetails + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                    Class DynamicMenuBar.DynamicMenuBarDetails +

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Responder
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    View
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    FrameView
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    DynamicMenuBar.DynamicMenuBarDetails
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    + View.Data +
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    + View.Id +
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    + View.X +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + View.Y +
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public class DynamicMenuBarDetails : FrameView, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    Constructors +

                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                    DynamicMenuBarDetails(ustring)

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public DynamicMenuBarDetails(ustring title)
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                    NStack.ustringtitle
                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                    DynamicMenuBarDetails(MenuItem, Boolean)

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public DynamicMenuBarDetails(MenuItem menuItem = null, bool hasParent = false)
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                    MenuItemmenuItem
                                                                                                                                                                                                                                                                                                                                                                                                    System.BooleanhasParent
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    Fields +

                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    _ckbIsTopLevel

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public CheckBox _ckbIsTopLevel
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Field Value
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                    CheckBox
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    _ckbSubMenu

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public CheckBox _ckbSubMenu
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Field Value
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                    CheckBox
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    _menuItem

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public MenuItem _menuItem
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Field Value
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                    MenuItem
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    _rbChkStyle

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public RadioGroup _rbChkStyle
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Field Value
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                    RadioGroup
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    _txtAction

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public TextView _txtAction
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Field Value
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                    TextView
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    _txtHelp

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public TextField _txtHelp
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Field Value
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                    TextField
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    _txtShortcut

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public TextField _txtShortcut
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Field Value
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                    TextField
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    _txtTitle

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public TextField _txtTitle
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Field Value
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                    TextField
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                    CreateAction(MenuItem, DynamicMenuBar.DynamicMenuItem)

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public Action CreateAction(MenuItem menuItem, DynamicMenuBar.DynamicMenuItem item)
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                    MenuItemmenuItem
                                                                                                                                                                                                                                                                                                                                                                                                    DynamicMenuBar.DynamicMenuItemitem
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                    System.Action
                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                    EditMenuBarItem(MenuItem)

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public void EditMenuBarItem(MenuItem menuItem)
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                    MenuItemmenuItem
                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                    EnterMenuItem()

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public DynamicMenuBar.DynamicMenuItem EnterMenuItem()
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                    DynamicMenuBar.DynamicMenuItem
                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                    UpdateParent(ref MenuItem)

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                    public void UpdateParent(ref MenuItem menuItem)
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                    MenuItemmenuItem
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuBarSample.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuBarSample.html new file mode 100644 index 0000000000..fedabe424d --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuBarSample.html @@ -0,0 +1,761 @@ + + + + + + + + Class DynamicMenuBar.DynamicMenuBarSample + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                                                                                                                      Class DynamicMenuBar.DynamicMenuBarSample +

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Responder
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      View
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Toplevel
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Window
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      DynamicMenuBar.DynamicMenuBarSample
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Implements
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                      + View.Data +
                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                      + View.Id +
                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                      + View.X +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + View.Y +
                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                      public class DynamicMenuBarSample : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Constructors +

                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                      DynamicMenuBarSample(ustring)

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                      public DynamicMenuBarSample(ustring title)
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                      NStack.ustringtitle
                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Properties +

                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                      DataContext

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                      public DynamicMenuBar.DynamicMenuItemModel DataContext { get; set; }
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                      DynamicMenuBar.DynamicMenuItemModel
                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItem.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItem.html new file mode 100644 index 0000000000..d7bb993feb --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItem.html @@ -0,0 +1,406 @@ + + + + + + + + Class DynamicMenuBar.DynamicMenuItem + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                        Class DynamicMenuBar.DynamicMenuItem +

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        DynamicMenuBar.DynamicMenuItem
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                        public class DynamicMenuItem
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        Constructors +

                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                        DynamicMenuItem()

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                        public DynamicMenuItem()
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                        DynamicMenuItem(ustring, ustring, ustring, Boolean, Boolean, MenuItemCheckStyle, ustring)

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                        public DynamicMenuItem(ustring title, ustring help, ustring action, bool isTopLevel, bool hasSubMenu, MenuItemCheckStyle checkStyle = MenuItemCheckStyle.NoCheck, ustring shortcut = null)
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                        NStack.ustringtitle
                                                                                                                                                                                                                                                                                                                                                                                                        NStack.ustringhelp
                                                                                                                                                                                                                                                                                                                                                                                                        NStack.ustringaction
                                                                                                                                                                                                                                                                                                                                                                                                        System.BooleanisTopLevel
                                                                                                                                                                                                                                                                                                                                                                                                        System.BooleanhasSubMenu
                                                                                                                                                                                                                                                                                                                                                                                                        MenuItemCheckStylecheckStyle
                                                                                                                                                                                                                                                                                                                                                                                                        NStack.ustringshortcut
                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                        DynamicMenuItem(ustring, Boolean)

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                        public DynamicMenuItem(ustring title, bool hasSubMenu = false)
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                        NStack.ustringtitle
                                                                                                                                                                                                                                                                                                                                                                                                        System.BooleanhasSubMenu
                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        Fields +

                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        action

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                        public ustring action
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                        NStack.ustring
                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        checkStyle

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                        public MenuItemCheckStyle checkStyle
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                        MenuItemCheckStyle
                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        hasSubMenu

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                        public bool hasSubMenu
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        help

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                        public ustring help
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                        NStack.ustring
                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        isTopLevel

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                        public bool isTopLevel
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                        System.Boolean
                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        shortcut

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                        public ustring shortcut
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                        NStack.ustring
                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        title

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                        public ustring title
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                        NStack.ustring
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItemList.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItemList.html new file mode 100644 index 0000000000..294b2432a6 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItemList.html @@ -0,0 +1,267 @@ + + + + + + + + Class DynamicMenuBar.DynamicMenuItemList + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                                                                                                          Class DynamicMenuBar.DynamicMenuItemList +

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          DynamicMenuBar.DynamicMenuItemList
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                          public class DynamicMenuItemList
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          Constructors +

                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                          DynamicMenuItemList()

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                          public DynamicMenuItemList()
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                          DynamicMenuItemList(ustring, MenuItem)

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                          public DynamicMenuItemList(ustring title, MenuItem menuItem)
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                          NStack.ustringtitle
                                                                                                                                                                                                                                                                                                                                                                                                          MenuItemmenuItem
                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          Properties +

                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                          MenuItem

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                          public MenuItem MenuItem { get; set; }
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                          MenuItem
                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                          Title

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                          public ustring Title { get; set; }
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                          NStack.ustring
                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                          ToString()

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                          public override string ToString()
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                          System.String
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          System.Object.ToString()
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItemModel.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItemModel.html new file mode 100644 index 0000000000..46f5065d32 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItemModel.html @@ -0,0 +1,310 @@ + + + + + + + + Class DynamicMenuBar.DynamicMenuItemModel + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                                            Class DynamicMenuBar.DynamicMenuItemModel +

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            DynamicMenuBar.DynamicMenuItemModel
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Implements
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            System.ComponentModel.INotifyPropertyChanged
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                            public class DynamicMenuItemModel : INotifyPropertyChanged
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Constructors +

                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                            DynamicMenuItemModel()

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                            public DynamicMenuItemModel()
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Properties +

                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                            MenuBar

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                            public ustring MenuBar { get; set; }
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                            NStack.ustring
                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                            Menus

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                            public List<DynamicMenuBar.DynamicMenuItemList> Menus { get; set; }
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                            System.Collections.Generic.List<DynamicMenuBar.DynamicMenuItemList>
                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                            Parent

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                            public ustring Parent { get; set; }
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Property Value
                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                            NStack.ustring
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                            GetPropertyName(String)

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                            public string GetPropertyName(string propertyName = null)
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                            System.StringpropertyName
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                            System.String
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Events +

                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            PropertyChanged

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                            public event PropertyChangedEventHandler PropertyChanged
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Event Type
                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                            System.ComponentModel.PropertyChangedEventHandler
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + System.ComponentModel.INotifyPropertyChanged +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.IValueConverter.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.IValueConverter.html new file mode 100644 index 0000000000..99958e5789 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.IValueConverter.html @@ -0,0 +1,173 @@ + + + + + + + + Interface DynamicMenuBar.IValueConverter + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                                                                                                                                                              Interface DynamicMenuBar.IValueConverter +

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                              public interface IValueConverter
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Methods +

                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                              Convert(Object, Object)

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                              object Convert(object value, object parameter = null)
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                              System.Objectvalue
                                                                                                                                                                                                                                                                                                                                                                                                              System.Objectparameter
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.ListWrapperConverter.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.ListWrapperConverter.html new file mode 100644 index 0000000000..0801848267 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.ListWrapperConverter.html @@ -0,0 +1,210 @@ + + + + + + + + Class DynamicMenuBar.ListWrapperConverter + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                                                Class DynamicMenuBar.ListWrapperConverter +

                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                DynamicMenuBar.ListWrapperConverter
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                Implements
                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                public class ListWrapperConverter : DynamicMenuBar.IValueConverter
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                Convert(Object, Object)

                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                public object Convert(object value, object parameter = null)
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                System.Objectvalue
                                                                                                                                                                                                                                                                                                                                                                                                                System.Objectparameter
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                Implements

                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.UStringValueConverter.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.UStringValueConverter.html new file mode 100644 index 0000000000..5ee33a2d22 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.UStringValueConverter.html @@ -0,0 +1,210 @@ + + + + + + + + Class DynamicMenuBar.UStringValueConverter + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                                                                                                                  Class DynamicMenuBar.UStringValueConverter +

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  DynamicMenuBar.UStringValueConverter
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  Implements
                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                  public class UStringValueConverter : DynamicMenuBar.IValueConverter
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                  Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                  Convert(Object, Object)

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                  public object Convert(object value, object parameter = null)
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                  System.Objectvalue
                                                                                                                                                                                                                                                                                                                                                                                                                  System.Objectparameter
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  Returns
                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                  Implements

                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.html new file mode 100644 index 0000000000..7c6386299b --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.html @@ -0,0 +1,234 @@ + + + + + + + + Class DynamicMenuBar + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                                    Class DynamicMenuBar +

                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    DynamicMenuBar
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                    [Scenario.ScenarioMetadata("Dynamic MenuBar", "Demonstrates how to change a MenuBar dynamically.")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+[Scenario.ScenarioCategory("Menus")]
+public class DynamicMenuBar : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                    Init(Toplevel, ColorScheme)

                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                    public override void Init(Toplevel top, ColorScheme colorScheme)
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                    Topleveltop
                                                                                                                                                                                                                                                                                                                                                                                                                    ColorSchemecolorScheme
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.Binding.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.Binding.html new file mode 100644 index 0000000000..0e1e9f8eac --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.Binding.html @@ -0,0 +1,296 @@ + + + + + + + + Class DynamicStatusBar.Binding + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                                                                                                                                      Class DynamicStatusBar.Binding +

                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      DynamicStatusBar.Binding
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                      public class Binding
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors +

                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                      Binding(View, String, View, String, DynamicStatusBar.IValueConverter)

                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                      public Binding(View source, string sourcePropertyName, View target, string targetPropertyName, DynamicStatusBar.IValueConverter valueConverter = null)
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                      Viewsource
                                                                                                                                                                                                                                                                                                                                                                                                                      System.StringsourcePropertyName
                                                                                                                                                                                                                                                                                                                                                                                                                      Viewtarget
                                                                                                                                                                                                                                                                                                                                                                                                                      System.StringtargetPropertyName
                                                                                                                                                                                                                                                                                                                                                                                                                      DynamicStatusBar.IValueConvertervalueConverter
                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                      Properties +

                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                      Source

                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                      public View Source { get; }
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                      View
                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                      SourcePropertyName

                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                      public string SourcePropertyName { get; }
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                      System.String
                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                      Target

                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                      public View Target { get; }
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                      View
                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                      TargetPropertyName

                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                      public string TargetPropertyName { get; }
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Property Value
                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                      System.String
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusBarDetails.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusBarDetails.html new file mode 100644 index 0000000000..07338bf8db --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusBarDetails.html @@ -0,0 +1,826 @@ + + + + + + + + Class DynamicStatusBar.DynamicStatusBarDetails + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                                        Class DynamicStatusBar.DynamicStatusBarDetails +

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Responder
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        View
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        FrameView
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBar.DynamicStatusBarDetails
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Implements
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        + View.Data +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        + View.Id +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        + View.X +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + View.Y +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                        public class DynamicStatusBarDetails : FrameView, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors +

                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBarDetails(ustring)

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                        public DynamicStatusBarDetails(ustring title)
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                        NStack.ustringtitle
                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBarDetails(StatusItem)

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                        public DynamicStatusBarDetails(StatusItem statusItem = null)
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                        StatusItemstatusItem
                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        Fields +

                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        _statusItem

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                        public StatusItem _statusItem
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                        StatusItem
                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        _txtAction

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                        public TextView _txtAction
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                        TextView
                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        _txtShortcut

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                        public TextField _txtShortcut
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                        TextField
                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        _txtTitle

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                        public TextField _txtTitle
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Field Value
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                        TextField
                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                        CreateAction(DynamicStatusBar.DynamicStatusItem)

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                        public Action CreateAction(DynamicStatusBar.DynamicStatusItem item)
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBar.DynamicStatusItemitem
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                        System.Action
                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                        EditStatusItem(StatusItem)

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                        public void EditStatusItem(StatusItem statusItem)
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                        StatusItemstatusItem
                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                        EnterStatusItem()

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                        public DynamicStatusBar.DynamicStatusItem EnterStatusItem()
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Returns
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBar.DynamicStatusItem
                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusBarSample.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusBarSample.html new file mode 100644 index 0000000000..d74c5d5262 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusBarSample.html @@ -0,0 +1,808 @@ + + + + + + + + Class DynamicStatusBar.DynamicStatusBarSample + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                                                                                                                          Class DynamicStatusBar.DynamicStatusBarSample +

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Responder
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          View
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Toplevel
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Window
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          DynamicStatusBar.DynamicStatusBarSample
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Implements
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                          + View.Data +
                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                          + View.Id +
                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                          + View.X +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + View.Y +
                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                          public class DynamicStatusBarSample : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors +

                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                          DynamicStatusBarSample(ustring)

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                          public DynamicStatusBarSample(ustring title)
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                          NStack.ustringtitle
                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                          Properties +

                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                          DataContext

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                          public DynamicStatusBar.DynamicStatusItemModel DataContext { get; set; }
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Property Value
                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                          DynamicStatusBar.DynamicStatusItemModel
                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                          SetTitleText(ustring, ustring)

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                          public static ustring SetTitleText(ustring title, ustring shortcut)
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                          NStack.ustringtitle
                                                                                                                                                                                                                                                                                                                                                                                                                          NStack.ustringshortcut
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Returns
                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                          NStack.ustring
                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                          Implements

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItem.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItem.html new file mode 100644 index 0000000000..7576060134 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItem.html @@ -0,0 +1,293 @@ + + + + + + + + Class DynamicStatusBar.DynamicStatusItem + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                                                            Class DynamicStatusBar.DynamicStatusItem +

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            DynamicStatusBar.DynamicStatusItem
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                            public class DynamicStatusItem
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors +

                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                            DynamicStatusItem()

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                            public DynamicStatusItem()
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                            DynamicStatusItem(ustring)

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                            public DynamicStatusItem(ustring title)
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                            NStack.ustringtitle
                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                            DynamicStatusItem(ustring, ustring, ustring)

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                            public DynamicStatusItem(ustring title, ustring action, ustring shortcut = null)
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                            NStack.ustringtitle
                                                                                                                                                                                                                                                                                                                                                                                                                            NStack.ustringaction
                                                                                                                                                                                                                                                                                                                                                                                                                            NStack.ustringshortcut
                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            Fields +

                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            action

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                            public ustring action
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Field Value
                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                            NStack.ustring
                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            shortcut

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                            public ustring shortcut
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Field Value
                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                            NStack.ustring
                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            title

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                            public ustring title
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Field Value
                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                            NStack.ustring
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItemList.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItemList.html new file mode 100644 index 0000000000..f3588f4e42 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItemList.html @@ -0,0 +1,267 @@ + + + + + + + + Class DynamicStatusBar.DynamicStatusItemList + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                                                                                                                                                                              Class DynamicStatusBar.DynamicStatusItemList +

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              DynamicStatusBar.DynamicStatusItemList
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                              public class DynamicStatusItemList
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors +

                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                              DynamicStatusItemList()

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                              public DynamicStatusItemList()
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                              DynamicStatusItemList(ustring, StatusItem)

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                              public DynamicStatusItemList(ustring title, StatusItem statusItem)
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                              TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                              NStack.ustringtitle
                                                                                                                                                                                                                                                                                                                                                                                                                              StatusItemstatusItem
                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Properties +

                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                              StatusItem

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                              public StatusItem StatusItem { get; set; }
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                              StatusItem
                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                              Title

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                              public ustring Title { get; set; }
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Property Value
                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                              NStack.ustring
                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                              ToString()

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                              public override string ToString()
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                              System.String
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              System.Object.ToString()
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItemModel.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItemModel.html new file mode 100644 index 0000000000..8a9882385e --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItemModel.html @@ -0,0 +1,287 @@ + + + + + + + + Class DynamicStatusBar.DynamicStatusItemModel + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                Class DynamicStatusBar.DynamicStatusItemModel +

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                DynamicStatusBar.DynamicStatusItemModel
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                System.ComponentModel.INotifyPropertyChanged
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                public class DynamicStatusItemModel : INotifyPropertyChanged
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors +

                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                DynamicStatusItemModel()

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                public DynamicStatusItemModel()
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Properties +

                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                Items

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                public List<DynamicStatusBar.DynamicStatusItemList> Items { get; set; }
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                System.Collections.Generic.List<DynamicStatusBar.DynamicStatusItemList>
                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                StatusBar

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                public ustring StatusBar { get; set; }
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Property Value
                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                NStack.ustring
                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                GetPropertyName(String)

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                public string GetPropertyName(string propertyName = null)
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                System.StringpropertyName
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Returns
                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                System.String
                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Events +

                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                PropertyChanged

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                public event PropertyChangedEventHandler PropertyChanged
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Event Type
                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                System.ComponentModel.PropertyChangedEventHandler
                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + System.ComponentModel.INotifyPropertyChanged +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.IValueConverter.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.IValueConverter.html new file mode 100644 index 0000000000..c816b466d8 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.IValueConverter.html @@ -0,0 +1,173 @@ + + + + + + + + Interface DynamicStatusBar.IValueConverter + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface DynamicStatusBar.IValueConverter +

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                  public interface IValueConverter
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Convert(Object, Object)

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                  object Convert(object value, object parameter = null)
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  System.Objectvalue
                                                                                                                                                                                                                                                                                                                                                                                                                                  System.Objectparameter
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns
                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.ListWrapperConverter.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.ListWrapperConverter.html new file mode 100644 index 0000000000..92ec0e31bf --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.ListWrapperConverter.html @@ -0,0 +1,210 @@ + + + + + + + + Class DynamicStatusBar.ListWrapperConverter + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Class DynamicStatusBar.ListWrapperConverter +

                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    DynamicStatusBar.ListWrapperConverter
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                    public class ListWrapperConverter : DynamicStatusBar.IValueConverter
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Convert(Object, Object)

                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                    public object Convert(object value, object parameter = null)
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                    System.Objectvalue
                                                                                                                                                                                                                                                                                                                                                                                                                                    System.Objectparameter
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns
                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.UStringValueConverter.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.UStringValueConverter.html new file mode 100644 index 0000000000..893cae8973 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.UStringValueConverter.html @@ -0,0 +1,210 @@ + + + + + + + + Class DynamicStatusBar.UStringValueConverter + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Class DynamicStatusBar.UStringValueConverter +

                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      DynamicStatusBar.UStringValueConverter
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                                      public class UStringValueConverter : DynamicStatusBar.IValueConverter
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Convert(Object, Object)

                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                                      public object Convert(object value, object parameter = null)
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                      System.Objectvalue
                                                                                                                                                                                                                                                                                                                                                                                                                                      System.Objectparameter
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.html b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.html new file mode 100644 index 0000000000..b29a0cba0a --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.html @@ -0,0 +1,233 @@ + + + + + + + + Class DynamicStatusBar + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Class DynamicStatusBar +

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBar
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                                        [Scenario.ScenarioMetadata("Dynamic StatusBar", "Demonstrates how to add and remove a StatusBar and change items dynamically.")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+public class DynamicStatusBar : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Init(Toplevel, ColorScheme)

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                                        public override void Init(Toplevel top, ColorScheme colorScheme)
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                        Topleveltop
                                                                                                                                                                                                                                                                                                                                                                                                                                        ColorSchemecolorScheme
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.Editor.html b/docs/api/UICatalog/UICatalog.Scenarios.Editor.html new file mode 100644 index 0000000000..8f57bce66c --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.Editor.html @@ -0,0 +1,245 @@ + + + + + + + + Class Editor + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                          Class Editor +

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Editor
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                          [Scenario.ScenarioMetadata("Editor", "A Text Editor using the TextView control.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Dialogs")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+[Scenario.ScenarioCategory("Files and IO")]
+[Scenario.ScenarioCategory("TextView")]
+public class Editor : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                          Init(Toplevel, ColorScheme)

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                          public override void Init(Toplevel top, ColorScheme colorScheme)
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                          Topleveltop
                                                                                                                                                                                                                                                                                                                                                                                                                                          ColorSchemecolorScheme
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                          Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                          public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                          Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.GraphViewExample.html b/docs/api/UICatalog/UICatalog.Scenarios.GraphViewExample.html new file mode 100644 index 0000000000..6600c60333 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.GraphViewExample.html @@ -0,0 +1,211 @@ + + + + + + + + Class GraphViewExample + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                            Class GraphViewExample +

                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            GraphViewExample
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                                            [Scenario.ScenarioMetadata("Graph View", "Demos the GraphView control.")]
+[Scenario.ScenarioCategory("Controls")]
+public class GraphViewExample : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                                            Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                                            public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.HexEditor.html b/docs/api/UICatalog/UICatalog.Scenarios.HexEditor.html new file mode 100644 index 0000000000..a8503cc3d3 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.HexEditor.html @@ -0,0 +1,215 @@ + + + + + + + + Class HexEditor + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Class HexEditor +

                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              HexEditor
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                                              [Scenario.ScenarioMetadata("HexEditor", "A binary (hex) editor using the HexView control.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Dialogs")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+[Scenario.ScenarioCategory("Files and IO")]
+public class HexEditor : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                                              public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                              Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.InteractiveTree.html b/docs/api/UICatalog/UICatalog.Scenarios.InteractiveTree.html new file mode 100644 index 0000000000..4175a50e7d --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.InteractiveTree.html @@ -0,0 +1,212 @@ + + + + + + + + Class InteractiveTree + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                Class InteractiveTree +

                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                InteractiveTree
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                [Scenario.ScenarioMetadata("Interactive Tree", "Create nodes and child nodes in TreeView.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("TreeView")]
+public class InteractiveTree : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.InvertColors.html b/docs/api/UICatalog/UICatalog.Scenarios.InvertColors.html new file mode 100644 index 0000000000..ac1bff16f3 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.InvertColors.html @@ -0,0 +1,212 @@ + + + + + + + + Class InvertColors + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Class InvertColors +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  InvertColors
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                  [Scenario.ScenarioMetadata("Invert Colors", "Invert the foreground and the background colors.")]
+[Scenario.ScenarioCategory("Colors")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+public class InvertColors : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                  public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.Keys.html b/docs/api/UICatalog/UICatalog.Scenarios.Keys.html new file mode 100644 index 0000000000..517bc5b858 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.Keys.html @@ -0,0 +1,240 @@ + + + + + + + + Class Keys + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Class Keys +

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Keys
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                    [Scenario.ScenarioMetadata("Keys", "Shows how to handle keyboard input")]
+[Scenario.ScenarioCategory("Mouse and Keyboard")]
+public class Keys : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Init(Toplevel, ColorScheme)

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                    public override void Init(Toplevel top, ColorScheme colorScheme)
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Topleveltop
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ColorSchemecolorScheme
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                    public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.LabelsAsLabels.html b/docs/api/UICatalog/UICatalog.Scenarios.LabelsAsLabels.html new file mode 100644 index 0000000000..786762c068 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.LabelsAsLabels.html @@ -0,0 +1,212 @@ + + + + + + + + Class LabelsAsLabels + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Class LabelsAsLabels +

                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      LabelsAsLabels
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                      [Scenario.ScenarioMetadata("Labels As Buttons", "Illustrates that Button is really just a Label++")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Proof of Concept")]
+public class LabelsAsLabels : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                      public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.LineViewExample.html b/docs/api/UICatalog/UICatalog.Scenarios.LineViewExample.html new file mode 100644 index 0000000000..89def456b6 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.LineViewExample.html @@ -0,0 +1,212 @@ + + + + + + + + Class LineViewExample + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Class LineViewExample +

                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        LineViewExample
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                        [Scenario.ScenarioMetadata("Line View", "Demonstrates drawing lines using the LineView control.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("LineView")]
+public class LineViewExample : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                        public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.ListViewWithSelection.html b/docs/api/UICatalog/UICatalog.Scenarios.ListViewWithSelection.html new file mode 100644 index 0000000000..eb748ecca9 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.ListViewWithSelection.html @@ -0,0 +1,324 @@ + + + + + + + + Class ListViewWithSelection + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Class ListViewWithSelection +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          ListViewWithSelection
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                          [Scenario.ScenarioMetadata("List View With Selection", "ListView with columns and selection")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("ListView")]
+public class ListViewWithSelection : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Fields +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          _allowMarkingCB

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                          public CheckBox _allowMarkingCB
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Field Value
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                          CheckBox
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          _allowMultipleCB

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                          public CheckBox _allowMultipleCB
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Field Value
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                          CheckBox
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          _customRenderCB

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                          public CheckBox _customRenderCB
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Field Value
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                          CheckBox
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          _listView

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                          public ListView _listView
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Field Value
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                          ListView
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          _scenarios

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                          public List<Type> _scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Field Value
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                          System.Collections.Generic.List<System.Type>
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                          public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.ListsAndCombos.html b/docs/api/UICatalog/UICatalog.Scenarios.ListsAndCombos.html new file mode 100644 index 0000000000..5841a49122 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.ListsAndCombos.html @@ -0,0 +1,213 @@ + + + + + + + + Class ListsAndCombos + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Class ListsAndCombos +

                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            ListsAndCombos
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                            [Scenario.ScenarioMetadata("ListView & ComboBox", "Demonstrates a ListView populating a ComboBox that acts as a filter.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("ListView")]
+[Scenario.ScenarioCategory("ComboBox")]
+public class ListsAndCombos : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                            public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.MessageBoxes.html b/docs/api/UICatalog/UICatalog.Scenarios.MessageBoxes.html new file mode 100644 index 0000000000..8e4f72b022 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.MessageBoxes.html @@ -0,0 +1,212 @@ + + + + + + + + Class MessageBoxes + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Class MessageBoxes +

                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              MessageBoxes
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                              [Scenario.ScenarioMetadata("MessageBoxes", "Demonstrates how to use the MessageBox class.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Dialogs")]
+public class MessageBoxes : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                              public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.Mouse.html b/docs/api/UICatalog/UICatalog.Scenarios.Mouse.html new file mode 100644 index 0000000000..53cb4287c2 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.Mouse.html @@ -0,0 +1,211 @@ + + + + + + + + Class Mouse + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Class Mouse +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Mouse
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                [Scenario.ScenarioMetadata("Mouse", "Demonstrates how to capture mouse events")]
+[Scenario.ScenarioCategory("Mouse and Keyboard")]
+public class Mouse : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.MultiColouredTable.html b/docs/api/UICatalog/UICatalog.Scenarios.MultiColouredTable.html new file mode 100644 index 0000000000..82c41fc6c4 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.MultiColouredTable.html @@ -0,0 +1,213 @@ + + + + + + + + Class MultiColouredTable + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Class MultiColouredTable +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  MultiColouredTable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [Scenario.ScenarioMetadata("MultiColouredTable", "Demonstrates how to multi color cell contents.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Colors")]
+[Scenario.ScenarioCategory("TableView")]
+public class MultiColouredTable : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.MyScenario.html b/docs/api/UICatalog/UICatalog.Scenarios.MyScenario.html new file mode 100644 index 0000000000..d61fc2fc63 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.MyScenario.html @@ -0,0 +1,211 @@ + + + + + + + + Class MyScenario + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Class MyScenario +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    MyScenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [Scenario.ScenarioMetadata("Generic", "Generic sample - A template for creating new Scenarios")]
+[Scenario.ScenarioCategory("Controls")]
+public class MyScenario : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.Notepad.html b/docs/api/UICatalog/UICatalog.Scenarios.Notepad.html new file mode 100644 index 0000000000..d45e16b7a0 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.Notepad.html @@ -0,0 +1,243 @@ + + + + + + + + Class Notepad + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Class Notepad +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Notepad
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [Scenario.ScenarioMetadata("Notepad", "Multi tab text editor uising the TabView control.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("TabView")]
+public class Notepad : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Save()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      public void Save()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SaveAs()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      public bool SaveAs()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      System.Boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.Progress.html b/docs/api/UICatalog/UICatalog.Scenarios.Progress.html new file mode 100644 index 0000000000..e3fcb3fc6e --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.Progress.html @@ -0,0 +1,237 @@ + + + + + + + + Class Progress + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Class Progress +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Progress
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [Scenario.ScenarioMetadata("Progress", "Shows off ProgressBar and Threading.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Threading")]
+[Scenario.ScenarioCategory("ProgressBar")]
+public class Progress : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Dispose(Boolean)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        protected override void Dispose(bool disposing)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        System.Booleandisposing
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.ProgressBarStyles.html b/docs/api/UICatalog/UICatalog.Scenarios.ProgressBarStyles.html new file mode 100644 index 0000000000..ad9c83b18b --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.ProgressBarStyles.html @@ -0,0 +1,213 @@ + + + + + + + + Class ProgressBarStyles + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Class ProgressBarStyles +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ProgressBarStyles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [Scenario.ScenarioMetadata("ProgressBar Styles", "Shows the ProgressBar Styles.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("ProgressBar")]
+[Scenario.ScenarioCategory("Threading")]
+public class ProgressBarStyles : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.RuneWidthGreaterThanOne.html b/docs/api/UICatalog/UICatalog.Scenarios.RuneWidthGreaterThanOne.html new file mode 100644 index 0000000000..55f4767b17 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.RuneWidthGreaterThanOne.html @@ -0,0 +1,240 @@ + + + + + + + + Class RuneWidthGreaterThanOne + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Class RuneWidthGreaterThanOne +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            RuneWidthGreaterThanOne
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [Scenario.ScenarioMetadata("RuneWidthGreaterThanOne", "Test rune width greater than one")]
+[Scenario.ScenarioCategory("Controls")]
+public class RuneWidthGreaterThanOne : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Init(Toplevel, ColorScheme)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            public override void Init(Toplevel top, ColorScheme colorScheme)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Topleveltop
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ColorSchemecolorScheme
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Run()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            public override void Run()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.Scrolling.html b/docs/api/UICatalog/UICatalog.Scenarios.Scrolling.html new file mode 100644 index 0000000000..ecf3745889 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.Scrolling.html @@ -0,0 +1,212 @@ + + + + + + + + Class Scrolling + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Class Scrolling +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Scrolling
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [Scenario.ScenarioMetadata("Scrolling", "Demonstrates ScrollView etc...")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("ScrollView")]
+public class Scrolling : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.SendKeys.html b/docs/api/UICatalog/UICatalog.Scenarios.SendKeys.html new file mode 100644 index 0000000000..bc8e14d813 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.SendKeys.html @@ -0,0 +1,211 @@ + + + + + + + + Class SendKeys + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Class SendKeys +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                SendKeys
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [Scenario.ScenarioMetadata("SendKeys", "SendKeys sample - Send key combinations.")]
+[Scenario.ScenarioCategory("Mouse and Keyboard")]
+public class SendKeys : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.MainApp.html b/docs/api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.MainApp.html new file mode 100644 index 0000000000..8c69a2fdf9 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.MainApp.html @@ -0,0 +1,703 @@ + + + + + + + + Class SingleBackgroundWorker.MainApp + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Class SingleBackgroundWorker.MainApp +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Responder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  View
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Toplevel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SingleBackgroundWorker.MainApp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + View.Data +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + View.Id +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + View.X +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + View.Y +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + View.Text +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  public class MainApp : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  MainApp()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  public MainApp()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.StagingUIController.html b/docs/api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.StagingUIController.html new file mode 100644 index 0000000000..2dd84c9dc8 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.StagingUIController.html @@ -0,0 +1,751 @@ + + + + + + + + Class SingleBackgroundWorker.StagingUIController + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Class SingleBackgroundWorker.StagingUIController +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Responder
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    View
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Toplevel
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Window
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SingleBackgroundWorker.StagingUIController
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    System.ComponentModel.ISupportInitializeNotification
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    System.ComponentModel.ISupportInitialize
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + View.Data +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + View.Id +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + View.X +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + View.Y +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    public class StagingUIController : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    StagingUIController(Nullable<DateTime>, List<String>)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    public StagingUIController(DateTime? start, List<string> list)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    System.Nullable<System.DateTime>start
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    System.Collections.Generic.List<System.String>list
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Load()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    public void Load()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.ComponentModel.ISupportInitializeNotification +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.ComponentModel.ISupportInitialize +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.html b/docs/api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.html new file mode 100644 index 0000000000..cb00464cf7 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.html @@ -0,0 +1,212 @@ + + + + + + + + Class SingleBackgroundWorker + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Class SingleBackgroundWorker +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SingleBackgroundWorker
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [Scenario.ScenarioMetadata("Single BackgroundWorker", "A single BackgroundWorker threading opening another Toplevel")]
+[Scenario.ScenarioCategory("Threading")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+public class SingleBackgroundWorker : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Run()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      public override void Run()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.SyntaxHighlighting.html b/docs/api/UICatalog/UICatalog.Scenarios.SyntaxHighlighting.html new file mode 100644 index 0000000000..01b34e6919 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.SyntaxHighlighting.html @@ -0,0 +1,213 @@ + + + + + + + + Class SyntaxHighlighting + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Class SyntaxHighlighting +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SyntaxHighlighting
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [Scenario.ScenarioMetadata("Syntax Highlighting", "Text editor with keyword highlighting using the TextView control.")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("TextView")]
+public class SyntaxHighlighting : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.TabViewExample.html b/docs/api/UICatalog/UICatalog.Scenarios.TabViewExample.html new file mode 100644 index 0000000000..ba5c7341c6 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.TabViewExample.html @@ -0,0 +1,212 @@ + + + + + + + + Class TabViewExample + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Class TabViewExample +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TabViewExample
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [Scenario.ScenarioMetadata("Tab View", "Demos TabView control with limited screen space in Absolute layout.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("TabView")]
+public class TabViewExample : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.TableEditor.html b/docs/api/UICatalog/UICatalog.Scenarios.TableEditor.html new file mode 100644 index 0000000000..b961a3f15e --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.TableEditor.html @@ -0,0 +1,307 @@ + + + + + + + + Class TableEditor + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Class TableEditor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TableEditor
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [Scenario.ScenarioMetadata("TableEditor", "Implements data table editor using the TableView control.")]
+[Scenario.ScenarioCategory("TableView")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Dialogs")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+public class TableEditor : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            BuildDemoDataTable(Int32, Int32)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Generates a new demo System.Data.DataTable with the given number of cols (min 5) and rows

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            public static DataTable BuildDemoDataTable(int cols, int rows)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            System.Int32cols
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            System.Int32rows
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            System.Data.DataTable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            BuildSimpleDataTable(Int32, Int32)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Builds a simple table in which cell values contents are the index of the cell. This helps testing that scrolling etc is working correctly and not skipping out any rows/columns when paging

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            public static DataTable BuildSimpleDataTable(int cols, int rows)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            System.Int32cols
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            System.Int32rows
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TypeDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            System.Data.DataTable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.Text.html b/docs/api/UICatalog/UICatalog.Scenarios.Text.html new file mode 100644 index 0000000000..39cf6fca0e --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.Text.html @@ -0,0 +1,213 @@ + + + + + + + + Class Text + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Class Text +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Text
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [Scenario.ScenarioMetadata("Text Input Controls", "Tests all text input controls")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Mouse and Keyboard")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+public class Text : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.TextAlignments.html b/docs/api/UICatalog/UICatalog.Scenarios.TextAlignments.html new file mode 100644 index 0000000000..1b3b93fd8e --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.TextAlignments.html @@ -0,0 +1,211 @@ + + + + + + + + Class TextAlignments + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Class TextAlignments +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                TextAlignments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [Scenario.ScenarioMetadata("Simple Text Alignment", "Demonstrates horizontal text alignment")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+public class TextAlignments : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.TextAlignmentsAndDirections.html b/docs/api/UICatalog/UICatalog.Scenarios.TextAlignmentsAndDirections.html new file mode 100644 index 0000000000..ea4a8d0091 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.TextAlignmentsAndDirections.html @@ -0,0 +1,211 @@ + + + + + + + + Class TextAlignmentsAndDirections + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Class TextAlignmentsAndDirections +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  TextAlignmentsAndDirections
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [Scenario.ScenarioMetadata("Text Alignment and Direction", "Demos horiztonal and vertical text alignment and text direction.")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+public class TextAlignmentsAndDirections : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.TextFormatterDemo.html b/docs/api/UICatalog/UICatalog.Scenarios.TextFormatterDemo.html new file mode 100644 index 0000000000..663ebc4424 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.TextFormatterDemo.html @@ -0,0 +1,211 @@ + + + + + + + + Class TextFormatterDemo + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Class TextFormatterDemo +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    TextFormatterDemo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [Scenario.ScenarioMetadata("TextFormatter Demo", "Demos and tests the TextFormatter class.")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+public class TextFormatterDemo : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.TextViewAutocompletePopup.html b/docs/api/UICatalog/UICatalog.Scenarios.TextViewAutocompletePopup.html new file mode 100644 index 0000000000..32ac0bff28 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.TextViewAutocompletePopup.html @@ -0,0 +1,213 @@ + + + + + + + + Class TextViewAutocompletePopup + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Class TextViewAutocompletePopup +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TextViewAutocompletePopup
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [Scenario.ScenarioMetadata("TextView Autocomplete Popup", "Shows five TextView Autocomplete Popup effects")]
+[Scenario.ScenarioCategory("TextView")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Mouse and Keyboard")]
+public class TextViewAutocompletePopup : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.Threading.html b/docs/api/UICatalog/UICatalog.Scenarios.Threading.html new file mode 100644 index 0000000000..d96532804b --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.Threading.html @@ -0,0 +1,211 @@ + + + + + + + + Class Threading + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Class Threading +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Threading
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [Scenario.ScenarioMetadata("Threading", "Demonstration of how to use threading in different ways")]
+[Scenario.ScenarioCategory("Threading")]
+public class Threading : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.TimeAndDate.html b/docs/api/UICatalog/UICatalog.Scenarios.TimeAndDate.html new file mode 100644 index 0000000000..f2d5768f0e --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.TimeAndDate.html @@ -0,0 +1,212 @@ + + + + + + + + Class TimeAndDate + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Class TimeAndDate +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TimeAndDate
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [Scenario.ScenarioMetadata("Time And Date", "Illustrates TimeField and time & date handling")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("DateTime")]
+public class TimeAndDate : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.TreeUseCases.html b/docs/api/UICatalog/UICatalog.Scenarios.TreeUseCases.html new file mode 100644 index 0000000000..eaeb11c522 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.TreeUseCases.html @@ -0,0 +1,212 @@ + + + + + + + + Class TreeUseCases + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Class TreeUseCases +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TreeUseCases
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [Scenario.ScenarioMetadata("Tree View", "Simple tree view examples.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("TreeView")]
+public class TreeUseCases : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.TreeViewFileSystem.html b/docs/api/UICatalog/UICatalog.Scenarios.TreeViewFileSystem.html new file mode 100644 index 0000000000..dc0ace5dcc --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.TreeViewFileSystem.html @@ -0,0 +1,213 @@ + + + + + + + + Class TreeViewFileSystem + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Class TreeViewFileSystem +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              TreeViewFileSystem
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [Scenario.ScenarioMetadata("TreeViewFileSystem", "Hierarchical file system explorer based on TreeView.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("TreeView")]
+[Scenario.ScenarioCategory("Files and IO")]
+public class TreeViewFileSystem : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.UnicodeInMenu.html b/docs/api/UICatalog/UICatalog.Scenarios.UnicodeInMenu.html new file mode 100644 index 0000000000..bcf085062a --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.UnicodeInMenu.html @@ -0,0 +1,212 @@ + + + + + + + + Class UnicodeInMenu + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Class UnicodeInMenu +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                UnicodeInMenu
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [Scenario.ScenarioMetadata("Unicode", "Tries to test Unicode in all controls (#204)")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+[Scenario.ScenarioCategory("Controls")]
+public class UnicodeInMenu : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.WindowsAndFrameViews.html b/docs/api/UICatalog/UICatalog.Scenarios.WindowsAndFrameViews.html new file mode 100644 index 0000000000..358a49cd39 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.WindowsAndFrameViews.html @@ -0,0 +1,254 @@ + + + + + + + + Class WindowsAndFrameViews + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Class WindowsAndFrameViews +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  WindowsAndFrameViews
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [Scenario.ScenarioMetadata("Windows & FrameViews", "Shows Windows, sub-Windows, and FrameViews.")]
+[Scenario.ScenarioCategory("Layout")]
+public class WindowsAndFrameViews : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Init(Toplevel, ColorScheme)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  public override void Init(Toplevel top, ColorScheme colorScheme)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Topleveltop
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ColorSchemecolorScheme
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  RequestStop()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  public override void RequestStop()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Run()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  public override void Run()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.WizardAsView.html b/docs/api/UICatalog/UICatalog.Scenarios.WizardAsView.html new file mode 100644 index 0000000000..8d94a1c20a --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.WizardAsView.html @@ -0,0 +1,240 @@ + + + + + + + + Class WizardAsView + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Class WizardAsView +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    WizardAsView
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [Scenario.ScenarioMetadata("WizardAsView", "Shows using the Wizard class in an non-modal way")]
+[Scenario.ScenarioCategory("Wizards")]
+public class WizardAsView : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Init(Toplevel, ColorScheme)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    public override void Init(Toplevel top, ColorScheme colorScheme)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    TypeNameDescription
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Topleveltop
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ColorSchemecolorScheme
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Run()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    public override void Run()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.Wizards.html b/docs/api/UICatalog/UICatalog.Scenarios.Wizards.html new file mode 100644 index 0000000000..02b086b361 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.Wizards.html @@ -0,0 +1,213 @@ + + + + + + + + Class Wizards + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Class Wizards +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Scenario
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Wizards
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implements
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      System.IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Namespace: UICatalog.Scenarios
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [Scenario.ScenarioMetadata("Wizards", "Demonstrates the Wizard class")]
+[Scenario.ScenarioCategory("Dialogs")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+[Scenario.ScenarioCategory("Wizards")]
+public class Wizards : Scenario, IDisposable
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Setup()

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Declaration
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      public override void Setup()
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Overrides
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + System.IDisposable +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + diff --git a/docs/api/UICatalog/UICatalog.Scenarios.html b/docs/api/UICatalog/UICatalog.Scenarios.html new file mode 100644 index 0000000000..92b2859a26 --- /dev/null +++ b/docs/api/UICatalog/UICatalog.Scenarios.html @@ -0,0 +1,290 @@ + + + + + + + + Namespace UICatalog.Scenarios + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Namespace UICatalog.Scenarios +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Classes +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        AllViewsTester

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        AutoSizeAndDirectionText

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        BackgroundWorkerCollection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        BasicColors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Borders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        BordersComparisons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        BordersOnFrameView

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        BordersOnToplevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        BordersOnWindow

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Buttons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        CharacterMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This Scenario demonstrates building a custom control (a class deriving from View) that:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Provides a simple "Character Map" application (like Windows' charmap.exe).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Helps test unicode character rendering in Terminal.Gui
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Illustrates how to use ScrollView to do infinite scrolling
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ClassExplorer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Clipping

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ColorPickers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ComboBoxIteration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ComputedLayout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This Scenario demonstrates how to use Termina.gui's Dim and Pos Layout System. +[x] - Using Dim.Fill to fill a window +[x] - Using Dim.Fill and Dim.Pos to automatically align controls based on an initial control +[ ] - ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ContextMenus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        CsvEditor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Dialogs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicMenuBar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicMenuBar.Binding

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicMenuBar.DynamicMenuBarDetails

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicMenuBar.DynamicMenuBarSample

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicMenuBar.DynamicMenuItem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicMenuBar.DynamicMenuItemList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicMenuBar.DynamicMenuItemModel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicMenuBar.ListWrapperConverter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicMenuBar.UStringValueConverter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBar.Binding

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBar.DynamicStatusBarDetails

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBar.DynamicStatusBarSample

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBar.DynamicStatusItem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBar.DynamicStatusItemList

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBar.DynamicStatusItemModel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBar.ListWrapperConverter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBar.UStringValueConverter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Editor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        GraphViewExample

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        HexEditor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        InteractiveTree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        InvertColors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Keys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        LabelsAsLabels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        LineViewExample

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ListsAndCombos

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ListViewWithSelection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        MessageBoxes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Mouse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        MultiColouredTable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        MyScenario

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Notepad

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Progress

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ProgressBarStyles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        RuneWidthGreaterThanOne

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Scrolling

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SendKeys

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SingleBackgroundWorker

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SingleBackgroundWorker.MainApp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SingleBackgroundWorker.StagingUIController

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SyntaxHighlighting

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TableEditor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TabViewExample

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Text

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TextAlignments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TextAlignmentsAndDirections

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TextFormatterDemo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TextViewAutocompletePopup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Threading

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TimeAndDate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TreeUseCases

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TreeViewFileSystem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        UnicodeInMenu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        WindowsAndFrameViews

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        WizardAsView

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Wizards

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interfaces +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicMenuBar.IValueConverter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        DynamicStatusBar.IValueConverter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + + + + diff --git a/docs/api/UICatalog/UICatalog.UICatalogApp.html b/docs/api/UICatalog/UICatalog.UICatalogApp.html new file mode 100644 index 0000000000..23bc91959a --- /dev/null +++ b/docs/api/UICatalog/UICatalog.UICatalogApp.html @@ -0,0 +1,156 @@ + + + + + + + + Class UICatalogApp + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Class UICatalogApp +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          UI Catalog is a comprehensive sample app and scenario library for Terminal.Gui

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Inheritance
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          System.Object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          UICatalogApp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Inherited Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.Equals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetHashCode() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.GetType() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.MemberwiseClone() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.ReferenceEquals(System.Object, System.Object) +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + System.Object.ToString() +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Namespace: UICatalog
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Assembly: UICatalog.dll
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Syntax
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          public class UICatalogApp
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + diff --git a/docs/api/UICatalog/UICatalog.html b/docs/api/UICatalog/UICatalog.html new file mode 100644 index 0000000000..3548d31c7b --- /dev/null +++ b/docs/api/UICatalog/UICatalog.html @@ -0,0 +1,144 @@ + + + + + + + + Namespace UICatalog + + + + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Search Results for
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Namespace UICatalog +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Classes +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            NumberToWords

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scenario

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Base class for each demo/scenario.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + To define a new scenario: +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            1. Create a new .cs file in the Scenarios directory that derives from Scenario.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            2. Annotate the Scenario derived class with a Scenario.ScenarioMetadata attribute specifying the scenario's name and description.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            3. Add one or more Scenario.ScenarioCategory attributes to the class specifying which categories the scenario belongs to. If you don't specify a category the scenario will show up in "_All".
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            4. Implement the Setup() override which will be called when a user selects the scenario to run.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            5. Optionally, implement the Init(Toplevel, ColorScheme) and/or Run() overrides to provide a custom implementation.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +The UI Catalog program uses reflection to find all scenarios and adds them to the +ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it. / +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scenario.ScenarioCategory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Defines the category names used to catagorize a Scenario

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scenario.ScenarioMetadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Defines the metadata (Name and Description) for a Scenario

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            UICatalogApp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            UI Catalog is a comprehensive sample app and scenario library for Terminal.Gui

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + + + + diff --git a/docs/api/UICatalog/toc.html b/docs/api/UICatalog/toc.html new file mode 100644 index 0000000000..7ad38b28a1 --- /dev/null +++ b/docs/api/UICatalog/toc.html @@ -0,0 +1,282 @@ + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/articles/index.html b/docs/articles/index.html index 37aad5d7d8..67ac50f676 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -8,7 +8,7 @@ Conceptual Documentation - + diff --git a/docs/articles/keyboard.html b/docs/articles/keyboard.html index 95a0e02afa..8ad4ee2903 100644 --- a/docs/articles/keyboard.html +++ b/docs/articles/keyboard.html @@ -8,7 +8,7 @@ Keyboard Event Processing - + diff --git a/docs/articles/mainloop.html b/docs/articles/mainloop.html index e6820ef279..79bc9059d1 100644 --- a/docs/articles/mainloop.html +++ b/docs/articles/mainloop.html @@ -8,7 +8,7 @@ Event Processing and the Application Main Loop - + @@ -93,11 +93,11 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Event Processing and the
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • On Unix systems, it can monitor file descriptors for readability or writability.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • The MainLoop property in the the -Application +Application provides access to these functions.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            When your code invokes Application.Run (Toplevel), the application will prepare the current -Toplevel instance by +Toplevel instance by redrawing the screen appropriately and then calling the mainloop to run.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            You can configure the Mainloop before calling Application.Run, or you diff --git a/docs/articles/overview.html b/docs/articles/overview.html index 2d5c8acd74..9b0297c340 100644 --- a/docs/articles/overview.html +++ b/docs/articles/overview.html @@ -8,7 +8,7 @@ Terminal.Gui API Overview - + @@ -105,9 +105,9 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Terminal.Gui API Overview

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            the various views that are included. In the following sections, you will see how applications are put together.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In the example above, you can see that we have initialized the runtime by calling the -Init method in the Application class - this sets up the environment, initializes the color +Init method in the Application class - this sets up the environment, initializes the color schemes available for your application and clears the screen to start your application.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The Application class, additionally creates an instance of the Toplevel class that is ready to be consumed, +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The Application class, additionally creates an instance of the Toplevel class that is ready to be consumed, this instance is available in the Application.Top property, and can be used like this:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            using Terminal.Gui;
 
@@ -158,12 +158,12 @@ 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Terminal.Gui API Overview
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
 }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Views

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            All visible elements on a Terminal.Gui application are implemented as -Views. Views are self-contained +Views. Views are self-contained objects that take care of displaying themselves, can receive keyboard and mouse input and participate in the focus mechanism.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Every view can contain an arbitrary number of children views. These are called the Subviews. You can add a view to an existing view, by calling the -Add method, for example, to add a couple of buttons to a UI, you can do this:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +Add method, for example, to add a couple of buttons to a UI, you can do this:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            void SetupMyView (View myView)
 {
     var label = new Label ("Username: ") {
@@ -185,14 +185,14 @@ 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Terminal.Gui API Overview

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The container of a given view is called the SuperView and it is a property of every View.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            There are many views that you can use to spice up your application:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Buttons, Labels, Text entry, Text view, Radio buttons, Checkboxes, Dialog boxes, Message boxes, Windows, Menus, ListViews, Frames, ProgressBars, Scroll views and Scrollbars.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Buttons, Labels, Text entry, Text view, Radio buttons, Checkboxes, Dialog boxes, Message boxes, Windows, Menus, ListViews, Frames, ProgressBars, Scroll views and Scrollbars.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Layout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Terminal.Gui supports two different layout systems, absolute and computed \ -(controlled by the LayoutStyle +(controlled by the LayoutStyle property on the view.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The absolute system is used when you want the view to be positioned exactly in one location and want to manually control where the view is. This is done -by invoking your View constructor with an argument of type Rect. When you do this, to change the +by invoking your View constructor with an argument of type Rect. When you do this, to change the position of the View, you can change the Frame property on the View.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The computed layout system offers a few additional capabilities, like automatic centering, expanding of dimensions and a handful of other features. To use @@ -210,7 +210,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Layout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Absolute position using the provided rectangle var label2 = new Label (new Rect (1, 2, 20, 1), "World") -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The computed layout system does not take integers, instead the X and Y properties are of type Pos and the Width and Height properties are of type Dim both which can be created implicitly from integer values.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The computed layout system does not take integers, instead the X and Y properties are of type Pos and the Width and Height properties are of type Dim both which can be created implicitly from integer values.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The Pos Type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            The Pos type on X and Y offers a few options: